Skip to content

Commit 2b866fe

Browse files
Add Sphinx documentation source path and favicon (#41)
* Add path to documentation in Sphinx configuration Update the Sphinx configuration to indicate where the documentation source is located. This ensures buttons created with `use_edit_page_button` correctly reference the documentation source. * Add favicon for Sphinx documentation - Add `favicon.png` to `docs/source/_static/`. - Update Sphinx configuration to use `favicon.png` as the documentation page favicon. This improves the documentation by displaying a custom favicon in browser tabs.
1 parent dca810e commit 2b866fe

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

docs/source/_static/favicon.png

8.94 KB
Loading

docs/source/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ def parse_attributes_section(self: GoogleDocstring, section: str) -> list[str]:
8484
# -- Options for HTML output --
8585
html_theme = "sphinx_book_theme"
8686
html_title = "Direct Data-Driven MPC"
87+
html_favicon = "_static/favicon.png"
8788
html_last_updated_fmt = ""
8889
html_static_path = ["_static"]
8990
html_css_files = ["styles.css"]
@@ -95,6 +96,7 @@ def parse_attributes_section(self: GoogleDocstring, section: str) -> list[str]:
9596

9697
html_theme_options = {
9798
"repository_url": "https://github.com/pavelacamposp/direct-data-driven-mpc",
99+
"path_to_docs": "docs/source/",
98100
"use_repository_button": True,
99101
"use_edit_page_button": True,
100102
"use_issues_button": True,

0 commit comments

Comments
 (0)