From 288a4519cb1bfebc18f2f321f0e26312b5492f52 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Fri, 3 Jun 2016 16:15:08 -0700 Subject: [PATCH] Add a bit of docs --- README.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.rst b/README.rst index f700ffe0..9087282e 100644 --- a/README.rst +++ b/README.rst @@ -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 =========