Permalink
Browse files

Display logo in reference manual

Some other minor tweaks
  • Loading branch information...
daar committed Oct 20, 2017
1 parent e08b746 commit e861a78b84390a0dc4cf178a722ebec911af428f
Showing with 34 additions and 15 deletions.
  1. +34 −15 docs/developers/source/conf.py
@@ -24,13 +24,19 @@
# -- General configuration ------------------------------------------------
# local var only
opsim_version = "0.02"
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.mathjax'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -47,18 +53,20 @@
master_doc = 'index'
# General information about the project.
project = 'OpSim developers'
copyright = '2016, OpSim team'
author = 'OpSim team'
project = 'OpSim %s Dev Manual' % opsim_version
copyright = '2016-2017, the OpSim team'
author = 'the OpSim team'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.01'
version = opsim_version
# The full version, including alpha/beta/rc tags.
release = '0.01'
release = opsim_version
del opsim_version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -118,23 +126,34 @@
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme_path = []
if html_theme == "sphinx_rtd_theme":
import sphinx_rtd_theme
html_theme_path.append(sphinx_rtd_theme.get_html_theme_path())
del sphinx_rtd_theme
# included in the title
html_theme_options = {
"display_version": False,
"canonical_url": "http://opsim.sourceforge.net/user-docs/html/",
}
# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#html_title = 'OpSim developers v0.01'
html_title = 'OpSim Developers'
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
html_logo = "../../../images/logo/logo.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
# pixels large.
#html_favicon = None
html_favicon = "../../../images/logo/favicon.ico"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
@@ -172,13 +191,13 @@
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
html_show_sphinx = False
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
@@ -204,7 +223,7 @@
#html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'OpSimdevelopersdoc'
htmlhelp_basename = 'OpSim Developers Manual'
# -- Options for LaTeX output ---------------------------------------------

0 comments on commit e861a78

Please sign in to comment.