diff options
author | Nicolas Lœuillet <nicolas@loeuillet.org> | 2015-10-22 17:02:06 +0200 |
---|---|---|
committer | Nicolas Lœuillet <nicolas@loeuillet.org> | 2015-10-22 17:02:06 +0200 |
commit | e686b5e6fe37b476d70eeadce34616d65572245b (patch) | |
tree | 850a783f53671a3ad71892c5d6bd41d1c4595043 /docs/en/conf.py | |
parent | 71200c4155490cb47b64172c3c2159f44cb80eca (diff) | |
parent | 59e91bc8931a386974a3817e9849aad1ca7fc186 (diff) | |
download | wallabag-e686b5e6fe37b476d70eeadce34616d65572245b.tar.gz wallabag-e686b5e6fe37b476d70eeadce34616d65572245b.tar.zst wallabag-e686b5e6fe37b476d70eeadce34616d65572245b.zip |
Merge pull request #1495 from wallabag/v2-docs
add docs
Diffstat (limited to 'docs/en/conf.py')
-rw-r--r-- | docs/en/conf.py | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/docs/en/conf.py b/docs/en/conf.py new file mode 100644 index 00000000..ae879a61 --- /dev/null +++ b/docs/en/conf.py | |||
@@ -0,0 +1,87 @@ | |||
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 | |||
6 | import sys | ||
7 | import os | ||
8 | |||
9 | extensions = [] | ||
10 | templates_path = ['_templates'] | ||
11 | source_suffix = '.rst' | ||
12 | master_doc = 'index' | ||
13 | project = u'wallabag' | ||
14 | copyright = u'2013-2015, Nicolas Lœuillet - MIT Licence' | ||
15 | version = '2.0.0' | ||
16 | release = version | ||
17 | exclude_patterns = ['_build'] | ||
18 | pygments_style = 'sphinx' | ||
19 | html_theme = 'default' | ||
20 | html_static_path = ['_static'] | ||
21 | htmlhelp_basename = 'wallabagdoc' | ||
22 | latex_elements = { | ||
23 | |||
24 | } | ||
25 | |||
26 | latex_documents = [ | ||
27 | ('index', 'wallabag.tex', u'wallabag Documentation', | ||
28 | u'Nicolas Lœuillet', 'manual'), | ||
29 | ] | ||
30 | |||
31 | man_pages = [ | ||
32 | ('index', 'wallabag', u'wallabag Documentation', | ||
33 | [u'Nicolas Lœuillet'], 1) | ||
34 | ] | ||
35 | |||
36 | texinfo_documents = [ | ||
37 | ('index', 'wallabag', u'wallabag Documentation', | ||
38 | u'Nicolas Lœuillet', 'wallabag', 'One line description of project.', | ||
39 | 'Miscellaneous'), | ||
40 | ] | ||
41 | |||
42 | ##### Guzzle sphinx theme | ||
43 | |||
44 | import guzzle_sphinx_theme | ||
45 | html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator' | ||
46 | html_theme_path = guzzle_sphinx_theme.html_theme_path() | ||
47 | html_theme = 'guzzle_sphinx_theme' | ||
48 | |||
49 | # Custom sidebar templates, maps document names to template names. | ||
50 | html_sidebars = { | ||
51 | '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html'] | ||
52 | } | ||
53 | |||
54 | # Register the theme as an extension to generate a sitemap.xml | ||
55 | extensions.append("guzzle_sphinx_theme") | ||
56 | |||
57 | # Guzzle theme options (see theme.conf for more information) | ||
58 | html_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 | } | ||