Skip to content

Commit

Permalink
Merge pull request #228 from onefinestay/sphinx-theme
Browse files Browse the repository at this point in the history
use nameko theme
  • Loading branch information
davidszotten committed Mar 31, 2015
2 parents 27f3121 + 41f98d1 commit 7798309
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 18 deletions.
20 changes: 4 additions & 16 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import os
import sphinx_nameko_theme
import pkg_resources

# If extensions (or modules to document with autodoc) are in another directory,
Expand Down Expand Up @@ -105,15 +105,16 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# html_theme = 'default'
html_theme = 'nameko'

# 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
# documentation.
# html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# Travis doesn't support the sphinx_themes setuptools entry point
html_theme_path = [sphinx_nameko_theme.get_html_theme_path()]

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
Expand Down Expand Up @@ -272,19 +273,6 @@
}
autoclass_content = 'both'

# -- Read The Docs Theme --------------------------------------------------

# on_rtd is whether we are on readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# otherwise, readthedocs.org uses their theme by default,
# so no need to specify it

# -- sphinxcontrib.spelling ------------------------------------------------

spelling_lang = 'en_GB'
Expand Down
4 changes: 4 additions & 0 deletions rtd_requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# ReadTheDocs doesn't support installation of requirements via extras_require
# See https://github.com/rtfd/readthedocs.org/issues/173

-e .[docs]
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@
],
'docs': [
"pyenchant==1.6.6",
"Sphinx==1.2",
"Sphinx==1.3",
"sphinxcontrib-spelling==2.1.1",
"sphinx-rtd-theme==0.1.6",
"sphinx-nameko-theme==0.0.2",
],
},
entry_points={
Expand Down

0 comments on commit 7798309

Please sign in to comment.