diff options
Diffstat (limited to 'doc/source/conf.py')
| -rw-r--r-- | doc/source/conf.py | 55 |
1 files changed, 31 insertions, 24 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index c0badf1d..f49f8015 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -12,7 +12,8 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os +import sys, os, time + sys.path.insert(0, os.path.abspath('../stub')) sys.path.append(os.path.abspath('../../src/')) @@ -31,7 +32,7 @@ sys.path.append(os.path.abspath('../../src/')) extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ['theme/templates'] # The suffix of source filenames. source_suffix = '.rst' @@ -43,22 +44,29 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = 'Poezio Plugin development' -copyright = '2013, Mathieu Pasquet - Florent Le Coz' +project = 'Poezio' +copyright = '%s, Mathieu Pasquet - Florent Le Coz' % time.strftime('%Y') # 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.1' +version = '0.8' # The full version, including alpha/beta/rc tags. -release = '0.1' +release = '0.8-dev' + +add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +add_module_names = True +# By default, highlight as Python 3. # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None - +highlight_language = 'python3' +language = 'python3' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' @@ -92,17 +100,16 @@ pygments_style = 'sphinx' # -- Options for HTML output --------------------------------------------------- -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' +html_theme = 'pydoctheme' +html_theme_path = ['theme/'] +html_theme_options = {'collapsiblesidebar': False} + +html_short_title = '%s Documentation' % release -# 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 = {} +# 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' -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = ['.'] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". @@ -123,7 +130,7 @@ html_theme_path = ['.'] # 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, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['theme/static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. @@ -164,10 +171,10 @@ html_static_path = ['_static'] #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 = 'PoezioPlugindevelopmentdoc' +htmlhelp_basename = 'PoezioDoc' # -- Options for LaTeX output -------------------------------------------------- @@ -186,7 +193,7 @@ latex_elements = { # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'PoezioPlugindevelopment.tex', 'Poezio Plugin development Documentation', + ('index', 'PoezioDoc.tex', 'Poezio Documentation', 'Mathieu Pasquet - Florent Le Coz', 'manual'), ] @@ -216,7 +223,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'poezioplugindevelopment', 'Poezio Plugin development Documentation', + ('index', 'poeziodoc', 'Poezio Documentation', ['Mathieu Pasquet - Florent Le Coz'], 1) ] @@ -230,8 +237,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'PoezioPlugindevelopment', 'Poezio Plugin development Documentation', - 'Mathieu Pasquet - Florent Le Coz', 'PoezioPlugindevelopment', 'One line description of project.', + ('index', 'PoezioDoc', 'Poezio Documentation', + 'Mathieu Pasquet - Florent Le Coz', 'PoezioDoc', 'Poezio Documentation', 'Miscellaneous'), ] |