From: Ondrej Lichtner <olichtne(a)redhat.com>
Hi all,
the following patch is a proposal for how to do documentation for
LNST-next. To review there are two parts:
* review the patch source code changes as usual, if there's something
that doesn't make sense code wise or similar...
* please also apply the patch locally and generate the documentation as
follows:
cd docs/
make html
Then open the generated html index file located at build/html/index.html
with your favourite browser.
To generate the documentation you will need "sphinx" installed, for me
that is provided by the python-sphinx package on Arch Linux, there
should be an equivalent package on other distrubutions or you can
install it via PyPI:
pip install -U sphinx
Thanks,
-Ondrej
Ondrej Lichtner (1):
Sphinx based documentation
README.md | 25 +-
docs/Makefile | 20 ++
docs/source/ControllerAPI.rst | 5 +
docs/source/Parameters.rst | 5 +
docs/source/RecipeAPI.rst | 5 +
docs/source/RecipeRequirementsAPI.rst | 5 +
docs/source/SimpleNetworkRecipe.rst | 6 +
docs/source/TesterAPI.rst | 10 +
docs/source/base_enrt_class.rst | 8 +
docs/source/conf.py | 64 +++++
docs/source/config_mixins.rst | 3 +
docs/source/enrt_recipes.rst | 12 +
docs/source/index.rst | 25 ++
docs/source/installation.rst | 133 +++++++++
docs/source/recipe_packages.rst | 7 +
docs/source/specific_scenarios.rst | 5 +
lnst/Common/Parameters.py | 23 +-
lnst/Controller/Controller.py | 92 +++---
lnst/Controller/Recipe.py | 71 ++---
lnst/Controller/Requirements.py | 80 ++++--
lnst/Controller/__init__.py | 7 +
lnst/Recipes/ENRT/BaseEnrtRecipe.py | 312 ++++++++++++++++++++-
lnst/Recipes/ENRT/ConfigMixins/README.md | 3 +
lnst/Recipes/ENRT/ConfigMixins/__init__.py | 9 +
lnst/Recipes/ENRT/README.md | 47 ++++
lnst/Recipes/ENRT/SimpleNetworkRecipe.py | 49 ++++
lnst/Recipes/ENRT/__init__.py | 52 ++++
27 files changed, 965 insertions(+), 118 deletions(-)
create mode 100644 docs/Makefile
create mode 100644 docs/source/ControllerAPI.rst
create mode 100644 docs/source/Parameters.rst
create mode 100644 docs/source/RecipeAPI.rst
create mode 100644 docs/source/RecipeRequirementsAPI.rst
create mode 100644 docs/source/SimpleNetworkRecipe.rst
create mode 100644 docs/source/TesterAPI.rst
create mode 100644 docs/source/base_enrt_class.rst
create mode 100644 docs/source/conf.py
create mode 100644 docs/source/config_mixins.rst
create mode 100644 docs/source/enrt_recipes.rst
create mode 100644 docs/source/index.rst
create mode 100644 docs/source/installation.rst
create mode 100644 docs/source/recipe_packages.rst
create mode 100644 docs/source/specific_scenarios.rst
create mode 100644 lnst/Recipes/ENRT/ConfigMixins/README.md
create mode 100644 lnst/Recipes/ENRT/README.md
--
2.25.1
Show replies by date