Skip to content

Conversation

pavelacamposp
Copy link
Owner

This PR improves the documentation page presentation by specifying the documentation source path (for edit suggestions) and adding a custom favicon to help differentiate the page in browser tabs.

Key changes:

  • Added favicon.png to docs/source/_static/.
  • Updated Sphinx configuration:
    • Added documentation source path (docs/source/) to html_theme_options.
    • Set favicon.png as the documentation page favicon.

pavelacamposp and others added 2 commits July 17, 2025 22:21
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.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.
@pavelacamposp pavelacamposp self-assigned this Jul 18, 2025
@pavelacamposp
Copy link
Owner Author

All checks have passed. This improves the documentation's presentation. Merging now.

@pavelacamposp pavelacamposp merged commit 2b866fe into main Jul 18, 2025
5 checks passed
@pavelacamposp pavelacamposp deleted the chore/add-docs-path-and-favicon branch July 18, 2025 03:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant