Doc fixes

This commit is contained in:
Serhii Snitsaruk 2024-01-12 23:42:32 +01:00
parent 48418114da
commit 74a0d44f44
4 changed files with 14 additions and 4 deletions

View File

@ -16,7 +16,7 @@ build:
# Build documentation in the "docs/" directory with Sphinx # Build documentation in the "docs/" directory with Sphinx
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 # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml" # builder: "dirhtml"
# Fail on all warnings to avoid broken references # Fail on all warnings to avoid broken references
@ -30,6 +30,6 @@ sphinx:
# Optional but recommended, declare the Python requirements required # Optional but recommended, declare the Python requirements required
# to build your documentation # to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python: python:
# install: install:
# - requirements: docs/requirements.txt - requirements: doc/source/requirements.txt

View File

@ -33,3 +33,9 @@ exclude_patterns = ['_build']
html_theme = 'sphinx_rtd_theme' html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static'] html_static_path = ['_static']
html_logo = "logo.png"
html_theme_options = {
'logo_only': True,
'display_version': True,
}

BIN
doc/source/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.8 KiB

View File

@ -0,0 +1,4 @@
sphinx
sphinx-rtd-theme
myst-parser
sphinx_markdown_builder