sphinx

.readthedocs.yaml

@@ -1,7 +1,3 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
 # Required
 version: 2
 
@@ -10,15 +6,6 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.12"
-    # You can also specify other tool versions:
-    # nodejs: "19"
-    # rust: "1.64"
-    # golang: "1.19"
-
-# Optionally build your docs in additional formats such as PDF and ePub
-# formats:
-#    - pdf
-#    - epub
 
 # Optional but recommended, declare the Python requirements required
 # to build your documentation

docs/requirements.txt

@@ -1 +1,2 @@
 myst_parser
+sphinx-pdj-theme

docs/source/code.rst

@@ -6,3 +6,9 @@ Code
    :toctree: generated
 
     marl_factory_grid
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   generated/*

docs/source/conf.py

@@ -23,13 +23,16 @@ extensions = ['myst_parser',
               ]
 
 templates_path = ['_templates']
-exclude_patterns = ['marl_factory_grid.utils.proto']
+exclude_patterns = ['marl_factory_grid.utils.proto', 'marl_factory_grid.utils.proto.fiksProto_pb2*']
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here.
 from pathlib import Path
 import sys
 sys.path.insert(0, (Path(__file__).parents[2]).resolve().as_posix())
+import sphinx_pdj_theme
+html_theme = 'sphinx_pdj_theme'
+html_theme_path = [sphinx_pdj_theme.get_html_theme_path()]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

docs/source/index.rst

@@ -15,8 +15,6 @@ Welcome to marl-factory-grid's documentation!
    modifications
    code
 
-.. autosummary::
-   :toctree: generated
 
 .. note::
    This project is under active development.