Mercurial > jouvence

comparison docs/conf.py @ 31:9ae14e9615e6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: Add Sphynx documentation and code docstrings.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 15 Jan 2017 22:41:49 -0800
parents
children 7c39da93a0ce
comparison
equal deleted inserted replaced
30:ff71a3e7fab0 31:9ae14e9615e6
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3 #
4 # Jouvence documentation build configuration file, created by
5 # sphinx-quickstart on Sun Jan 15 18:04:24 2017.
6 #
7 # This file is execfile()d with the current directory set to its
8 # containing dir.
9 #
10 # Note that not all possible configuration values are present in this
11 # autogenerated file.
12 #
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
15
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19
20 import os
21 import sys
22 sys.path.append(os.path.dirname(os.path.dirname(__file__)))
23
24
25 # -- General configuration ------------------------------------------------
26
27 # If your documentation needs a minimal Sphinx version, state it here.
28 #
29 # needs_sphinx = '1.0'
30
31 # Add any Sphinx extension module names here, as strings. They can be
32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33 # ones.
34 extensions = [
35 'sphinx.ext.autodoc',
36 'sphinx.ext.coverage']
37
38 # Add any paths that contain templates here, relative to this directory.
39 templates_path = ['_templates']
40
41 # The suffix(es) of source filenames.
42 # You can specify multiple suffix as a list of string:
43 #
44 # source_suffix = ['.rst', '.md']
45 source_suffix = '.rst'
46
47 # The master toctree document.
48 master_doc = 'index'
49
50 # General information about the project.
51 project = 'Jouvence'
52 copyright = '2017, BOLT80'
53 author = 'Ludovic Chabant'
54
55 # The version info for the project you're documenting, acts as replacement for
56 # |version| and |release|, also used in various other places throughout the
57 # built documents.
58 #
59 # The short X.Y version.
60 version = '0.3.1'
61 # The full version, including alpha/beta/rc tags.
62 release = '0.3.1'
63
64 # The language for content autogenerated by Sphinx. Refer to documentation
65 # for a list of supported languages.
66 #
67 # This is also used if you do content translation via gettext catalogs.
68 # Usually you set "language" from the command line for these cases.
69 language = None
70
71 # List of patterns, relative to source directory, that match files and
72 # directories to ignore when looking for source files.
73 # This patterns also effect to html_static_path and html_extra_path
74 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
75
76 # The name of the Pygments (syntax highlighting) style to use.
77 pygments_style = 'sphinx'
78
79 # If true, `todo` and `todoList` produce output, else they produce nothing.
80 todo_include_todos = False
81
82
83 # -- Options for HTML output ----------------------------------------------
84
85 # The theme to use for HTML and HTML Help pages. See the documentation for
86 # a list of builtin themes.
87 #
88 html_theme = 'alabaster'
89
90 # Theme options are theme-specific and customize the look and feel of a theme
91 # further. For a list of options available for each theme, see the
92 # documentation.
93 #
94 # html_theme_options = {}
95
96 # Add any paths that contain custom static files (such as style sheets) here,
97 # relative to this directory. They are copied after the builtin static files,
98 # so a file named "default.css" will overwrite the builtin "default.css".
99 html_static_path = ['_static']
100
101
102 # -- Options for HTMLHelp output ------------------------------------------
103
104 # Output file base name for HTML help builder.
105 htmlhelp_basename = 'Jouvencedoc'
106
107
108 # -- Options for LaTeX output ---------------------------------------------
109
110 latex_elements = {
111 # The paper size ('letterpaper' or 'a4paper').
112 #
113 # 'papersize': 'letterpaper',
114
115 # The font size ('10pt', '11pt' or '12pt').
116 #
117 # 'pointsize': '10pt',
118
119 # Additional stuff for the LaTeX preamble.
120 #
121 # 'preamble': '',
122
123 # Latex figure (float) alignment
124 #
125 # 'figure_align': 'htbp',
126 }
127
128 # Grouping the document tree into LaTeX files. List of tuples
129 # (source start file, target name, title,
130 # author, documentclass [howto, manual, or own class]).
131 latex_documents = [
132 (master_doc, 'Jouvence.tex', 'Jouvence Documentation',
133 'Ludovic Chabant', 'manual'),
134 ]
135
136
137 # -- Options for manual page output ---------------------------------------
138
139 # One entry per manual page. List of tuples
140 # (source start file, name, description, authors, manual section).
141 man_pages = [
142 (master_doc, 'jouvence', 'Jouvence Documentation',
143 [author], 1)
144 ]
145
146
147 # -- Options for Texinfo output -------------------------------------------
148
149 # Grouping the document tree into Texinfo files. List of tuples
150 # (source start file, target name, title, author,
151 # dir menu entry, description, category)
152 texinfo_documents = [
153 (master_doc, 'Jouvence', 'Jouvence Documentation',
154 author, 'Jouvence', 'One line description of project.',
155 'Miscellaneous'),
156 ]