From b9dc37940bbbf5747426f8aa493852e6694da03b Mon Sep 17 00:00:00 2001 From: enriquetomasmb Date: Mon, 15 Jul 2024 11:06:05 +0200 Subject: [PATCH] Improve docs --- .github/workflows/documentation.yml | 1 + docs/conf.py | 4 ++-- docs/nebula.rst | 9 +++++++++ docs/nebula.tests.rst | 21 +++++++++++++++++++++ 4 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 docs/nebula.tests.rst diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 90d96e1e..196365bb 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -41,6 +41,7 @@ jobs: - name: Add files run: | echo "nebula.enriquetomasmb.com" > docs/_build/CNAME + touch docs/_build/.nojekyll - name: List directories run: | ls -la docs/_build/ diff --git a/docs/conf.py b/docs/conf.py index 2be5ebfc..96ac33ff 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -58,7 +58,7 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = 'sphinx_book_theme' -html_static_path = ['static'] +html_static_path = ['_static'] html_css_files = ['custom.css'] html_theme_options = { @@ -66,7 +66,7 @@ "use_repository_button": True, } -html_logo = "static/nebula-logo.jpg" +html_logo = "_static/nebula-logo.jpg" html_title = "NEBULA Documentation" diff --git a/docs/nebula.rst b/docs/nebula.rst index b116cd17..59984300 100644 --- a/docs/nebula.rst +++ b/docs/nebula.rst @@ -11,6 +11,7 @@ Subpackages nebula.config nebula.core nebula.frontend + nebula.tests Submodules ---------- @@ -31,6 +32,14 @@ nebula.node module :undoc-members: :show-inheritance: +nebula.scenarios module +----------------------- + +.. automodule:: nebula.scenarios + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/nebula.tests.rst b/docs/nebula.tests.rst new file mode 100644 index 00000000..8cf0c066 --- /dev/null +++ b/docs/nebula.tests.rst @@ -0,0 +1,21 @@ +nebula.tests package +==================== + +Submodules +---------- + +nebula.tests.main module +------------------------ + +.. automodule:: nebula.tests.main + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula.tests + :members: + :undoc-members: + :show-inheritance: