improvements on the dev documentation website

- new home page (inspired from the python's one)
- add a "How to contribute" page
- add logo/favicon
- more customizations
This commit is contained in:
Romain Bignon 2014-08-30 20:44:11 +02:00
commit a9008e9b04
10 changed files with 180 additions and 18 deletions

View file

@ -11,7 +11,7 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
import os
import os, time
os.system('./genapi.py')
@ -40,7 +40,7 @@ master_doc = 'index'
# General information about the project.
project = u'Weboob'
copyright = u'2010-2012, Weboob Team'
copyright = '2010-%s, The Weboob Team' % 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
@ -98,26 +98,26 @@ html_theme = 'default'
# 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 = {'collapsiblesidebar': True}
# 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".
#html_title = None
#html_title = 'Weboob development'
# 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 = '_static/logo.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
html_favicon = '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,
@ -130,14 +130,18 @@ html_static_path = ['_static']
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
html_sidebars = {
'index': 'indexsidebar.html'
}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
html_additional_pages = {
'index': 'indexcontent.html'
}
# If false, no module index is generated.
#html_use_modindex = True
@ -146,10 +150,10 @@ html_static_path = ['_static']
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
html_show_sourcelink = False
# 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
@ -160,7 +164,7 @@ html_static_path = ['_static']
#html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'Weboobdoc'
htmlhelp_basename = 'weboob' + release.replace('.', '')
# -- Options for LaTeX output --------------------------------------------------