Repository navigation
feat(docs): add "Edit on GitHub" link to all manuals - #123
Merged
Merged
Conversation
Signed-off-by: Matheus Andrade <2002matheus@gmail.com>
vitormattos
approved these changes
Nov 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Matheus
Closes #28
Implementation details
Every manual page now shows the
sphinx_rtd_theme"Edit on GitHub" link at the top, pointing to the matching.rstsource inLibreSign/documentation, like the Nextcloud documentation.Sphinx configuration
Central configuration (root
conf.py)New
html_context:Per-manual configuration
main/,user_manual/,admin_manual/anddeveloper_manual/already dofrom conf import *. Each one now overrides only its own path:Example generated link for
user_manual/start.rst:https://github.com/LibreSign/documentation/blob/main/user_manual/start.rst.Impact
blob/(theme default), notedit/: opens the file on GitHub, one click from the edit button.main.