diff --git a/README.rst b/README.rst index a080195c..91def048 100644 --- a/README.rst +++ b/README.rst @@ -22,6 +22,7 @@ Read the Docs Sphinx Theme ************************** .. contents:: + :backlinks: none View a working demo_ over on readthedocs.org_. diff --git a/docs/conf.py b/docs/conf.py index 299d72b5..67824eee 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,8 +14,12 @@ import sys import os + +sys.path.append(os.path.abspath('..')) sys.path.append(os.path.abspath('./demo/')) +from sphinx_rtd_theme import __version__ + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -51,17 +55,17 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Sphinx RTD theme demo' -copyright = u'2013, Dave Snider' +project = u'Read the Docs Sphinx Theme' +copyright = u'Read the Docs, Inc & contributors' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.2.4' +version = __version__ # The full version, including alpha/beta/rc tags. -release = '0.2.4' +release = __version__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -125,7 +129,7 @@ html_theme_path = ["../.."] # The name of an image file (relative to this directory) to place at the top # of the sidebar. -html_logo = "static/logo-wordmark-light.svg" +html_logo = "demo/static/logo-wordmark-light.svg" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 diff --git a/docs/demo/index.rst b/docs/demo/index.rst index b2f4a962..1c85869f 100644 --- a/docs/demo/index.rst +++ b/docs/demo/index.rst @@ -1,5 +1,3 @@ - -************************ Read the Docs Theme Demo ************************ diff --git a/docs/index.rst b/docs/index.rst index bfe155da..27bfdb75 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,13 @@ -************************ -Read the Docs Theme Docs -************************ +.. include:: ../README.rst + +Content +======= .. toctree:: + :caption: Theme - demo/index.rst +.. toctree:: + :caption: Demo + + demo/index