mmc-utils: Add Read-the-Docs configuration

Prior of building the documentation page, read-the-docs expects a github
project to be imported into it, so I had to mirror the mmc-utils repo
into https://github.com/avri-altman-wdc/mmc-utils.  It also expects some
mandatory settings in a configuration file - .readthedocs.yaml, add
those as well.  Finally, the public documentation is in
https://mmc-utils.readthedocs.io/en/latest/

Signed-off-by: Avri Altman <avri.altman@wdc.com>
Link: https://lore.kernel.org/r/20240624112542.25657-3-avri.altman@wdc.com
Signed-off-by: Ulf Hansson <ulf.hansson@linaro.org>
This commit is contained in:
Avri Altman 2024-06-24 14:25:42 +03:00 committed by Ulf Hansson
parent 1d1b1159ce
commit c8cef0598b
3 changed files with 24 additions and 1 deletions

17
.readthedocs.yaml Normal file
View File

@ -0,0 +1,17 @@
# SPDX-License-Identifier: GPL-2.0-only
# .readthedocs.yaml
version: 2
sphinx:
configuration: docs/conf.py
formats: all
python:
install:
- requirements: docs/requirements.txt
build:
os: "ubuntu-22.04" # Specify the OS (if this option becomes available)
tools:
python: "3.8"

6
README
View File

@ -12,13 +12,17 @@ process used for the Linux kernel itself.
One can document themselves by reading how to submit a patch in the official
Linux kernel documentation:
https://www.kernel.org/doc/html/latest/process/submitting-patches.html
Not all sections apply but it should be a good way to get started.
A patch should be sent as a mail (not as an attachement, see documentation
above) to the linux-mmc@vger.kernel.org mailing list with maintainers as
Cc recipients.
Documentation
-------------
https://mmc-utils.readthedocs.io/en/latest/
Maintainers
-----------

2
docs/requirements.txt Normal file
View File

@ -0,0 +1,2 @@
sphinx==4.3.2
jinja2>=2.11