Skip to content

Commit

Permalink
Use boost theme for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pfultz2 committed Oct 24, 2016
1 parent c31e00c commit 711e9fe
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
10 changes: 6 additions & 4 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import os
from recommonmark.parser import CommonMarkParser
from recommonmark.transform import AutoStructify
import sphinx_boost

# -- General configuration ------------------------------------------------

Expand Down Expand Up @@ -142,7 +143,7 @@ def parse_version():
highlight_language = 'cpp'

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'tango'

# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
Expand All @@ -159,7 +160,8 @@ def parse_version():
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'pyramid'
# html_theme = 'alabaster'
html_theme = 'boost'

# 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
Expand All @@ -168,7 +170,7 @@ def parse_version():
# html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
html_theme_path = [sphinx_boost.get_html_theme_path()]

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
Expand All @@ -182,7 +184,7 @@ def parse_version():
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
html_logo = 'boost-proposed.png'

# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
Expand Down
6 changes: 4 additions & 2 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
.. _contents:

Fit documentation contents
==========================
Fit
===

**Paul Fultz II**

.. toctree::
:maxdepth: 2
Expand Down
1 change: 1 addition & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
git+https://github.com/pfultz2/recommonmark@develop
git+https://github.com/pfultz2/sphinx@develop
sphinx-boost

0 comments on commit 711e9fe

Please sign in to comment.