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@xxxxxxx> --- .readthedocs.yaml | 17 +++++++++++++++++ README | 6 +++++- docs/requirements.txt | 2 ++ 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..c6e885c --- /dev/null +++ b/.readthedocs.yaml @@ -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" diff --git a/README b/README index 71a4e7d..f18fcde 100644 --- a/README +++ b/README @@ -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@xxxxxxxxxxxxxxx mailing list with maintainers as Cc recipients. +Documentation +------------- +https://mmc-utils.readthedocs.io/en/latest/ + + Maintainers ----------- diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..fbf6840 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx==4.3.2 +jinja2>=2.11 \ No newline at end of file -- 2.34.1
