diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..9a17f94d9 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,10 @@ +version: 2 + +sphinx: + configuration: docs/conf.py + +python: + version: 3.7 + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/README.rst b/README.rst index 29b9ffa56..3c8974f62 100644 --- a/README.rst +++ b/README.rst @@ -70,10 +70,12 @@ be considered unstable. Documentation ------------- -The SOCS documentation can be built using sphinx once you have performed the -installation:: +The SOCS documentation can be built using Sphinx. There is a separate +``requirements.txt`` file in the ``docs/`` directory to install Sphinx and any +additional documentation dependencies:: cd docs/ + pip3 install -r requirements.txt make html You can then open ``docs/_build/html/index.html`` in your preferred web diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..6de08b019 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +sphinx==4.2.0 +sphinx_rtd_theme==1.0.0 +sphinx-argparse==0.3.1 diff --git a/requirements.txt b/requirements.txt index 4edf49168..c2d2a513a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -19,7 +19,7 @@ pysnmp pysmi # Docs -sphinx_rtd_theme +# see docs/requirements.txt # testing pytest