tuning doc

This commit is contained in:
Romain Dorgueil
2016-12-09 13:19:42 +01:00
parent d84d3969c0
commit 9853b9073d
6 changed files with 50 additions and 30 deletions

View File

@ -1,6 +1,15 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import sys
import os
sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath('_themes'))
import bonobo
from bonobo import __version__
# -- General configuration ------------------------------------------------
extensions = [
@ -35,9 +44,9 @@ author = 'Romain Dorgueil'
# built documents.
#
# The short X.Y version.
version = ''
version = __version__
# The full version, including alpha/beta/rc tags.
release = ''
release = __version__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -57,7 +66,6 @@ pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
@ -68,20 +76,24 @@ html_theme = 'alabaster'
# 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 = {}
html_theme_options = {
'github_user': 'python-bonobo',
'github_repo': 'bonobo',
'github_button': True,
'show_powered_by': False,
'show_related': True,
}
html_sidebars = {
'**': [
'sidebarlogo.html', 'localtoc.html', 'relations.html', 'searchbox.html', 'sidebarinfos.html', 'sourcelink.html',
]
}
# 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_theme_options = {
'logo': 'logo.png',
'github_user': 'python-bonobo',
'github_repo': 'bonobo',
}
html_show_sphinx = False
# -- Options for HTMLHelp output ------------------------------------------
@ -89,7 +101,6 @@ html_show_sphinx = False
# Output file base name for HTML help builder.
htmlhelp_basename = 'Bonobodoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
@ -118,7 +129,6 @@ latex_documents = [
'Romain Dorgueil', 'manual'),
]
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
@ -128,7 +138,6 @@ man_pages = [
[author], 1)
]
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
@ -140,8 +149,6 @@ texinfo_documents = [
'Miscellaneous'),
]
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
@ -162,7 +169,5 @@ epub_copyright = copyright
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}