From 06e176cfd5c1c51a7325fa7e36fe8546918986bf Mon Sep 17 00:00:00 2001 From: Steffen Illium Date: Tue, 12 Dec 2023 08:51:44 +0100 Subject: [PATCH] sphinx --- .readthedocs.yaml | 13 ------------- docs/requirements.txt | 1 + docs/source/code.rst | 8 +++++++- docs/source/conf.py | 5 ++++- docs/source/index.rst | 2 -- 5 files changed, 12 insertions(+), 17 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index fa15592..2298655 100644 --- a/.readthedocs.yaml +++ b/.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 diff --git a/docs/requirements.txt b/docs/requirements.txt index 9e4694f..d459989 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,2 @@ myst_parser +sphinx-pdj-theme diff --git a/docs/source/code.rst b/docs/source/code.rst index da6358c..b00f965 100644 --- a/docs/source/code.rst +++ b/docs/source/code.rst @@ -5,4 +5,10 @@ Code :recursive: :toctree: generated - marl_factory_grid \ No newline at end of file + marl_factory_grid + +.. toctree:: + :maxdepth: 1 + :glob: + + generated/* \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 4cc306a..94c3794 100644 --- a/docs/source/conf.py +++ b/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 diff --git a/docs/source/index.rst b/docs/source/index.rst index e7bd885..e8d8e67 100644 --- a/docs/source/index.rst +++ b/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.