]> git.immae.eu Git - github/wallabag/wallabag.git/blame - docs/en/conf.py
Merge pull request #1558 from wallabag/v2-documentation
[github/wallabag/wallabag.git] / docs / en / conf.py
CommitLineData
59e91bc8
NL
1# -*- coding: utf-8 -*-
2#
3# wallabag documentation build configuration file, created by
4# sphinx-quickstart on Fri Oct 16 06:47:23 2015.
5
6import sys
7import os
8
9extensions = []
10templates_path = ['_templates']
11source_suffix = '.rst'
12master_doc = 'index'
13project = u'wallabag'
14copyright = u'2013-2015, Nicolas Lœuillet - MIT Licence'
15version = '2.0.0'
16release = version
17exclude_patterns = ['_build']
18pygments_style = 'sphinx'
19html_theme = 'default'
20html_static_path = ['_static']
21htmlhelp_basename = 'wallabagdoc'
22latex_elements = {
23
24}
25
26latex_documents = [
27 ('index', 'wallabag.tex', u'wallabag Documentation',
28 u'Nicolas Lœuillet', 'manual'),
29]
30
31man_pages = [
32 ('index', 'wallabag', u'wallabag Documentation',
33 [u'Nicolas Lœuillet'], 1)
34]
35
36texinfo_documents = [
37 ('index', 'wallabag', u'wallabag Documentation',
a42938f4 38 u'Nicolas Lœuillet', 'wallabag', 'wallabag is an opensource read-it-later.',
59e91bc8
NL
39 'Miscellaneous'),
40]
41
42##### Guzzle sphinx theme
43
44import guzzle_sphinx_theme
45html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator'
46html_theme_path = guzzle_sphinx_theme.html_theme_path()
47html_theme = 'guzzle_sphinx_theme'
48
49# Custom sidebar templates, maps document names to template names.
50html_sidebars = {
51 '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html']
52}
53
54# Register the theme as an extension to generate a sitemap.xml
55extensions.append("guzzle_sphinx_theme")
56
57# Guzzle theme options (see theme.conf for more information)
58html_theme_options = {
59
60 # Set the path to a special layout to include for the homepage
61 # "index_template": "homepage.html",
62
63 # Allow a separate homepage from the master_doc
64 # homepage = index
65
66 # Set the name of the project to appear in the nav menu
67 # "project_nav_name": "Guzzle",
68
69 # Set your Disqus short name to enable comments
70 # "disqus_comments_shortname": "my_disqus_comments_short_name",
71
72 # Set you GA account ID to enable tracking
73 # "google_analytics_account": "my_ga_account",
74
75 # Path to a touch icon
76 # "touch_icon": "",
77
78 # Specify a base_url used to generate sitemap.xml links. If not
79 # specified, then no sitemap will be built.
80 #"base_url": "http://guzzlephp.org"
81
82 # Allow the "Table of Contents" page to be defined separately from "master_doc"
83 # tocpage = Contents
84
85 # Allow the project link to be overriden to a custom URL.
86 # projectlink = http://myproject.url
87}