Skip to content

Commit

Permalink
Switched to using napoleon
Browse files Browse the repository at this point in the history
  • Loading branch information
wackywendell committed May 8, 2015
1 parent 8721a56 commit fe825fa
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
22 changes: 16 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,19 @@
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.doctest',
'numpydoc',
]

numpydoc_show_class_members = False
'sphinxcontrib.napoleon']

# Napoleon settings
napoleon_google_docstring = False
napoleon_numpy_docstring = True
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True

# Add any paths that contain templates here, relative to this directory.
templates_path = ['.templates']
Expand Down Expand Up @@ -121,8 +130,9 @@
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
except ImportError:
html_theme = 'agogo'
html_theme_options = {'headerbg': '#27ae60'}
#html_theme = 'agogo'
#html_theme_options = {'headerbg': '#27ae60'}
pass

# 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 Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
numpydoc
sphinxcontrib-napoleon
sphinx_rtd_theme
cython

0 comments on commit fe825fa

Please sign in to comment.