afonso/core-extra
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

small doc cleanup, updated python specific docs to leverage the sphix rtd theme as well

Browse source
This commit is contained in:
Blake J. Harnden 2017-08-18 11:34:25 -07:00
parent f55d241b36
commit abc9e06fe1
6 changed files with 23 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

11
daemon/doc/conf.py.in
View file

@ -12,6 +12,7 @@
# serve to show the default.
import sys, os
import sphinx_rtd_theme
# 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
@ -25,7 +26,7 @@ import sys, os
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig']
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.imgmath', 'sphinx.ext.ifconfig']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -41,7 +42,7 @@ master_doc = 'index'
# General information about the project.
project = u'CORE Python modules'
copyright = u'2012, core-dev'
copyright = u'2017, core-dev'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@ -91,7 +92,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# 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
# further. For a list of options available for each theme, see the
@ -99,7 +100,7 @@ html_theme = 'default'
#html_theme_options = {}
# 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
# "<project> v<release> documentation".
@ -222,7 +223,7 @@ man_pages = [
epub_title = u'CORE Python'
epub_author = u'core-dev'
epub_publisher = u'core-dev'
epub_copyright = u'2012, core-dev'
epub_copyright = u'2017, core-dev'
# The language of the text. It defaults to the language option
# or en if the language is not set.