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

Add a bit of docs

Browse Source
This commit is contained in:
Eric Holscher 2016-06-03 16:15:08 -07:00
parent 09abc5f15d
commit 288a4519cb
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.rst
View File

@ -61,6 +61,20 @@ conf.py file:
html_theme = "sphinx_rtd_theme"
html_theme_path = ["_themes", ]
Configuration
=============
You can configure different parts of the theme.
Page-level configuration
------------------------
Pages support metadata that changes how the theme renders.
You can currently add the following:
* ``:github_url:`` This will force the "Edit on GitHub" to the configured URL
* ``:bitbucket_url:`` This will force the "Edit on Bitbucket" to the configured URL
Changelog
=========