Change around a bunch of Sphinx settings.
parent
f7a5cb3953
commit
c77a40b820
43
docs/conf.py
43
docs/conf.py
|
@ -22,20 +22,20 @@ sys.path.insert(0, os.path.abspath('.'))
|
|||
# -- Autodoc settings ----------------------------------------------------------
|
||||
## trying to set this somewhere...
|
||||
autodoc_member_order = 'bysource'
|
||||
autodoc_default_flags = ['members', 'show-inheritance', 'undoc-members']
|
||||
autodoc_default_flags = ['members', 'show-inheritance', 'undoc-members', 'show-hidden']
|
||||
autoclass_content = 'both'
|
||||
|
||||
# -- General configuration -----------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
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 = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
templates_path = ['_static']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
@ -47,7 +47,7 @@ source_suffix = '.rst'
|
|||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'python-gnupg'
|
||||
project = u'gnupg'
|
||||
copyright = u'2013, Isis Agora Lovecruft'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
|
@ -68,7 +68,7 @@ release = gnupg.__version__
|
|||
# non-false value, then it is used:
|
||||
#today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#today_fmt = '%B %d, %Y'
|
||||
today_fmt = '%d %B %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
|
@ -86,10 +86,10 @@ add_function_parentheses = True
|
|||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#show_authors = False
|
||||
show_authors = True
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
pygments_style = 'monokai'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
@ -101,14 +101,17 @@ pygments_style = 'sphinx'
|
|||
# a list of builtin themes.
|
||||
html_theme = 'default'
|
||||
html_theme = 'scrolls'
|
||||
html_theme = 'traditional'
|
||||
html_theme = 'nature'
|
||||
html_theme = 'pyramid'
|
||||
#html_theme = 'traditional'
|
||||
#html_theme = 'nature'
|
||||
#html_theme = 'pyramid'
|
||||
html_theme = 'agogo'
|
||||
html_theme = 'haiku'
|
||||
#html_theme = 'haiku'
|
||||
# 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 = {
|
||||
# 'stickysidebar': 'true',
|
||||
# 'rightsidebar':'true',
|
||||
# 'rightsidebar':'true',
|
||||
'nosidebar': 'false',
|
||||
# 'full_logo': 'false'
|
||||
'sidebarwidth': '300'
|
||||
|
@ -122,7 +125,7 @@ html_theme_path = ['_static']
|
|||
#html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
html_short_title = "gnupg: Python Module Documentation"
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
|
@ -140,7 +143,7 @@ html_static_path = ['_static']
|
|||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
html_last_updated_fmt = '%A, %d %B %Y'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
|
@ -163,13 +166,13 @@ html_use_smartypants = True
|
|||
#html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
html_show_sourcelink = False
|
||||
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 = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
html_show_copyright = False
|
||||
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
|
||||
|
@ -177,10 +180,10 @@ html_show_copyright = False
|
|||
#html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
html_file_suffix = '.html'
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'python-gnupgdoc'
|
||||
htmlhelp_basename = 'gnupgdoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output --------------------------------------------------
|
||||
|
@ -229,7 +232,7 @@ latex_documents = [
|
|||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'python-gnupg', u'python-gnupg Documentation',
|
||||
('index', 'gnupg Python Module Docs', u'gnupg Python Module Documentation',
|
||||
[u'Isis Agora Lovecruft'], 1)
|
||||
]
|
||||
|
||||
|
|
Loading…
Reference in New Issue