Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-06-07 18:44:08 +00:00
Code Issues Actions Projects Releases Wiki Activity

switch to the rtd theme

Browse Source
This commit is contained in:
Julien Fastré 2014-10-10 23:26:15 +02:00
parent ea56ff5a08
commit a1466466ae
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -12,6 +12,7 @@ Compilation into HTML
To compile this documentation : To compile this documentation :
1. Install [sphinx-doc](http://sphinx-doc.org) 1. Install [sphinx-doc](http://sphinx-doc.org)
2. Install the Sphinx theme provided by Read the Docs : `sudo pip install sphinx_rtd_theme`
2. run `make html` from the root directory 2. run `make html` from the root directory
3. The base file is located on build/html/index.html 3. The base file is located on build/html/index.html

5
source/conf.py
View File

@ -15,6 +15,7 @@
import sys import sys
import os import os
import sphinx_rtd_theme
# If extensions (or modules to document with autodoc) are in another directory, # 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 # add these directories to sys.path here. If the directory is relative to the
@ -102,7 +103,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'default' html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
@ -110,7 +111,7 @@ html_theme = 'default'
#html_theme_options = {} #html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = [] html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".