From f351a8ab0536cae9bd815dbc465de81632f09836 Mon Sep 17 00:00:00 2001 From: Bruno Bernard Date: Tue, 17 Oct 2023 17:24:57 +0400 Subject: [PATCH 1/2] topotato: add missing configuration for sphinx doc Signed-off-by: Bruno Bernard --- doc/conf.py | 2 +- vm/ubuntu/topotato-install.sh | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 1f5625acd3b4..d2228ccba0a0 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -36,7 +36,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["sphinx.ext.todo", "sphinx.ext.graphviz", "sphinx.ext.autodoc"] +extensions = ["sphinx.ext.todo", "sphinx.ext.graphviz", "sphinx.ext.autodoc", "sphinx_rtd_theme"] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/vm/ubuntu/topotato-install.sh b/vm/ubuntu/topotato-install.sh index 2f5e5664dca2..523532712c1e 100644 --- a/vm/ubuntu/topotato-install.sh +++ b/vm/ubuntu/topotato-install.sh @@ -9,3 +9,7 @@ sudo DEBIAN_FRONTEND=noninteractive apt install graphviz tshark \ python3-venv wireshark-common python3-pip tini -y pip install -r requirements.txt + +# sphinx documentation + +pip install sphinx_rtd_theme \ No newline at end of file From 59cb41ea3976fb18cec60dc640c2f0790a477d8c Mon Sep 17 00:00:00 2001 From: Bruno Bernard Date: Wed, 18 Oct 2023 14:25:25 +0400 Subject: [PATCH 2/2] topotato: updated docs for internals folder Signed-off-by: Bruno Bernard --- doc/{ => internals}/assertions.rst | 0 doc/{ => internals}/frrglue.rst | 0 doc/{ => internals}/introduction.rst | 0 doc/{ => internals}/machinery.rst | 0 doc/{ => internals}/parse.rst | 0 doc/{ => internals}/pytest_lowlevel.rst | 0 doc/{ => internals}/utils.rst | 0 7 files changed, 0 insertions(+), 0 deletions(-) rename doc/{ => internals}/assertions.rst (100%) rename doc/{ => internals}/frrglue.rst (100%) rename doc/{ => internals}/introduction.rst (100%) rename doc/{ => internals}/machinery.rst (100%) rename doc/{ => internals}/parse.rst (100%) rename doc/{ => internals}/pytest_lowlevel.rst (100%) rename doc/{ => internals}/utils.rst (100%) diff --git a/doc/assertions.rst b/doc/internals/assertions.rst similarity index 100% rename from doc/assertions.rst rename to doc/internals/assertions.rst diff --git a/doc/frrglue.rst b/doc/internals/frrglue.rst similarity index 100% rename from doc/frrglue.rst rename to doc/internals/frrglue.rst diff --git a/doc/introduction.rst b/doc/internals/introduction.rst similarity index 100% rename from doc/introduction.rst rename to doc/internals/introduction.rst diff --git a/doc/machinery.rst b/doc/internals/machinery.rst similarity index 100% rename from doc/machinery.rst rename to doc/internals/machinery.rst diff --git a/doc/parse.rst b/doc/internals/parse.rst similarity index 100% rename from doc/parse.rst rename to doc/internals/parse.rst diff --git a/doc/pytest_lowlevel.rst b/doc/internals/pytest_lowlevel.rst similarity index 100% rename from doc/pytest_lowlevel.rst rename to doc/internals/pytest_lowlevel.rst diff --git a/doc/utils.rst b/doc/internals/utils.rst similarity index 100% rename from doc/utils.rst rename to doc/internals/utils.rst