Improve docs

CyberDataLab · Jul 15, 2024 · b9dc379 · b9dc379
1 parent 71bc5a9
commit b9dc379
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 2 deletions.
diff --git 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
@@ -58,15 +58,15 @@
 # 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 = {
     "repository_url": "https://github.com/enriquetomasmb/nebula",
     "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
@@ -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
@@ -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: