diff --git a/doc/source/.readthedocs.yaml b/doc/source/.readthedocs.yaml index 61585fa..7df6d86 100644 --- a/doc/source/.readthedocs.yaml +++ b/doc/source/.readthedocs.yaml @@ -16,7 +16,7 @@ build: # Build documentation in the "docs/" directory with Sphinx sphinx: - configuration: docs/src/conf.py + configuration: doc/source/conf.py # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs # builder: "dirhtml" # Fail on all warnings to avoid broken references @@ -30,6 +30,6 @@ sphinx: # Optional but recommended, declare the Python requirements required # to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt \ No newline at end of file +python: + install: + - requirements: doc/source/requirements.txt \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index 13047d4..fd76e11 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -33,3 +33,9 @@ exclude_patterns = ['_build'] html_theme = 'sphinx_rtd_theme' html_static_path = ['_static'] +html_logo = "logo.png" +html_theme_options = { + 'logo_only': True, + 'display_version': True, +} + diff --git a/doc/source/logo.png b/doc/source/logo.png new file mode 100644 index 0000000..0533077 Binary files /dev/null and b/doc/source/logo.png differ diff --git a/doc/source/requirements.txt b/doc/source/requirements.txt new file mode 100644 index 0000000..cb4f120 --- /dev/null +++ b/doc/source/requirements.txt @@ -0,0 +1,4 @@ +sphinx +sphinx-rtd-theme +myst-parser +sphinx_markdown_builder