IntenseWebs/sphinx_rtd_theme
3
0
Fork 0
mirror of https://github.com/readthedocs/sphinx_rtd_theme.git synced 2025-02-25 18:55:21 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge 4e263b38aa into 8d4d394dad

Browse Source
This commit is contained in:
Anatoli Babenia 2024-12-04 13:51:30 +03:00 committed by GitHub
commit 53fac7a4b1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 33 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/configuring.rst
View File

@ -221,8 +221,26 @@ Miscellaneous options
File-wide metadata
==================
The following options can be used as :ref:`file-wide metadata
<sphinx:metadata>`:
The following features are confugured per file in :ref:`file-wide metadata
<sphinx:metadata>`, but they could also be set for all files using
:ref:`html_context <spinx:html_context>` setting.
Enable "Edit on ..." links
--------------------------
To enable "Edit on GitHub" link, you can add ``github_url`` option to the
metadata of specific page, or use ``html_context`` to make this option set
for all pages.
For example:
.. code:: python
html_context = {
'github_url': 'https://github.com/readthedocs/sphinx_rtd_theme'
}
Note that such URLs are static.
.. confval:: github_url
@ -236,6 +254,19 @@ The following options can be used as :ref:`file-wide metadata
Force the :guilabel:`Edit on GitLab` button to use the configured URL.
To generate dynamic URLs, there exists a set of other options.
.. code:: python
html_context = {
'display_github': True,
# 'github_host': 'github.com',
'github_user': 'readthedocs',
'github_repo': 'sphinx_rtd_theme',
'github_version': 'master/docs/'
}
Other configuration
===================