1e8ba2890ad38828e1755818b9837837d78f541b
[wolnelektury.git] / doc / conf.py
1 # Wolne Lektury documentation build configuration file, created by
2 # sphinx-quickstart on Fri Mar 30 16:42:44 2012.
3 #
4 # This file is execfile()d with the current directory set to its containing dir.
5 #
6 # Note that not all possible configuration values are present in this
7 # autogenerated file.
8 #
9 # All configuration values have a default; values that are commented out
10 # serve to show the default.
11
12 import sys, os
13 import django
14
15 # If extensions (or modules to document with autodoc) are in another directory,
16 # add these directories to sys.path here. If the directory is relative to the
17 # documentation root, use os.path.abspath to make it absolute, like shown here.
18 #sys.path.insert(0, os.path.abspath('.'))
19 sys.path += [
20     os.path.abspath('../src'),
21 ]
22
23 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "wolnelektury.settings")
24 django.setup()
25
26
27
28 # -- General configuration -----------------------------------------------------
29
30 # If your documentation needs a minimal Sphinx version, state it here.
31 #needs_sphinx = '1.0'
32
33 # Add any Sphinx extension module names here, as strings. They can be extensions
34 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
35 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
36
37 # Add any paths that contain templates here, relative to this directory.
38 templates_path = ['_templates']
39
40 # The suffix of source filenames.
41 source_suffix = '.rst'
42
43 # The encoding of source files.
44 #source_encoding = 'utf-8-sig'
45
46 # The master toctree document.
47 master_doc = 'index'
48
49 # General information about the project.
50 project = 'Wolne Lektury'
51 copyright = '2007-2019, Fundacja Nowoczesna Polska'
52
53 # The version info for the project you're documenting, acts as replacement for
54 # |version| and |release|, also used in various other places throughout the
55 # built documents.
56 #
57 # The short X.Y version.
58 version = '1.8'
59 # The full version, including alpha/beta/rc tags.
60 release = '1.8'
61
62 # The language for content autogenerated by Sphinx. Refer to documentation
63 # for a list of supported languages.
64 #language = None
65
66 # There are two options for replacing |today|: either, you set today to some
67 # non-false value, then it is used:
68 #today = ''
69 # Else, today_fmt is used as the format for a strftime call.
70 #today_fmt = '%B %d, %Y'
71
72 # List of patterns, relative to source directory, that match files and
73 # directories to ignore when looking for source files.
74 exclude_patterns = ['_build']
75
76 # The reST default role (used for this markup: `text`) to use for all documents.
77 #default_role = None
78
79 # If true, '()' will be appended to :func: etc. cross-reference text.
80 #add_function_parentheses = True
81
82 # If true, the current module name will be prepended to all description
83 # unit titles (such as .. function::).
84 #add_module_names = True
85
86 # If true, sectionauthor and moduleauthor directives will be shown in the
87 # output. They are ignored by default.
88 #show_authors = False
89
90 # The name of the Pygments (syntax highlighting) style to use.
91 pygments_style = 'sphinx'
92
93 # A list of ignored prefixes for module index sorting.
94 #modindex_common_prefix = []
95
96
97 # -- Options for HTML output ---------------------------------------------------
98
99 # The theme to use for HTML and HTML Help pages.  See the documentation for
100 # a list of builtin themes.
101 html_theme = 'default'
102
103 # Theme options are theme-specific and customize the look and feel of a theme
104 # further.  For a list of options available for each theme, see the
105 # documentation.
106 #html_theme_options = {}
107
108 # Add any paths that contain custom themes here, relative to this directory.
109 #html_theme_path = []
110
111 # The name for this set of Sphinx documents.  If None, it defaults to
112 # "<project> v<release> documentation".
113 #html_title = None
114
115 # A shorter title for the navigation bar.  Default is the same as html_title.
116 #html_short_title = None
117
118 # The name of an image file (relative to this directory) to place at the top
119 # of the sidebar.
120 #html_logo = None
121
122 # The name of an image file (within the static path) to use as favicon of the
123 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
124 # pixels large.
125 #html_favicon = None
126
127 # Add any paths that contain custom static files (such as style sheets) here,
128 # relative to this directory. They are copied after the builtin static files,
129 # so a file named "default.css" will overwrite the builtin "default.css".
130 #html_static_path = ['_static']
131
132 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
133 # using the given strftime format.
134 #html_last_updated_fmt = '%b %d, %Y'
135
136 # If true, SmartyPants will be used to convert quotes and dashes to
137 # typographically correct entities.
138 #html_use_smartypants = True
139
140 # Custom sidebar templates, maps document names to template names.
141 #html_sidebars = {}
142
143 # Additional templates that should be rendered to pages, maps page names to
144 # template names.
145 #html_additional_pages = {}
146
147 # If false, no module index is generated.
148 #html_domain_indices = True
149
150 # If false, no index is generated.
151 #html_use_index = True
152
153 # If true, the index is split into individual pages for each letter.
154 #html_split_index = False
155
156 # If true, links to the reST sources are added to the pages.
157 #html_show_sourcelink = True
158
159 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
160 #html_show_sphinx = True
161
162 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
163 #html_show_copyright = True
164
165 # If true, an OpenSearch description file will be output, and all pages will
166 # contain a <link> tag referring to it.  The value of this option must be the
167 # base URL from which the finished HTML is served.
168 #html_use_opensearch = ''
169
170 # This is the file name suffix for HTML files (e.g. ".xhtml").
171 #html_file_suffix = None
172
173 # Output file base name for HTML help builder.
174 htmlhelp_basename = 'WolneLekturydoc'
175
176
177 # -- Options for LaTeX output --------------------------------------------------
178
179 # The paper size ('letter' or 'a4').
180 #latex_paper_size = 'letter'
181
182 # The font size ('10pt', '11pt' or '12pt').
183 #latex_font_size = '10pt'
184
185 # Grouping the document tree into LaTeX files. List of tuples
186 # (source start file, target name, title, author, documentclass [howto/manual]).
187 latex_documents = [
188   ('index', 'WolneLektury.tex', 'Wolne Lektury Documentation',
189    'Fundacja Nowoczesna Polska', 'manual'),
190 ]
191
192 # The name of an image file (relative to this directory) to place at the top of
193 # the title page.
194 #latex_logo = None
195
196 # For "manual" documents, if this is true, then toplevel headings are parts,
197 # not chapters.
198 #latex_use_parts = False
199
200 # If true, show page references after internal links.
201 #latex_show_pagerefs = False
202
203 # If true, show URL addresses after external links.
204 #latex_show_urls = False
205
206 # Additional stuff for the LaTeX preamble.
207 #latex_preamble = ''
208
209 # Documents to append as an appendix to all manuals.
210 #latex_appendices = []
211
212 # If false, no module index is generated.
213 #latex_domain_indices = True
214
215
216 # -- Options for manual page output --------------------------------------------
217
218 # One entry per manual page. List of tuples
219 # (source start file, name, description, authors, manual section).
220 man_pages = [
221     ('index', 'wolnelektury', 'Wolne Lektury Documentation',
222      ['Fundacja Nowoczesna Polska'], 1)
223 ]
224
225
226 # Example configuration for intersphinx: refer to the Python standard library.
227 intersphinx_mapping = {'http://docs.python.org/': None}