1 | # -*- coding: utf-8 -*- |
---|
2 | # |
---|
3 | # Configuration file for the Sphinx documentation builder. |
---|
4 | # |
---|
5 | # This file does only contain a selection of the most common options. For a |
---|
6 | # full list see the documentation: |
---|
7 | # http://www.sphinx-doc.org/en/master/config |
---|
8 | |
---|
9 | # -- Path setup -------------------------------------------------------------- |
---|
10 | |
---|
11 | # If extensions (or modules to document with autodoc) are in another directory, |
---|
12 | # add these directories to sys.path here. If the directory is relative to the |
---|
13 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
---|
14 | # |
---|
15 | # import os |
---|
16 | # import sys |
---|
17 | # sys.path.insert(0, os.path.abspath('.')) |
---|
18 | |
---|
19 | |
---|
20 | # -- Project information ----------------------------------------------------- |
---|
21 | |
---|
22 | project = 'OpenWorkouts' |
---|
23 | copyright = '2019, Borja Lopez Rio' |
---|
24 | author = 'Borja Lopez Rio' |
---|
25 | |
---|
26 | # The short X.Y version |
---|
27 | version = '' |
---|
28 | # The full version, including alpha/beta/rc tags |
---|
29 | release = '0.2.0' |
---|
30 | |
---|
31 | |
---|
32 | # -- General configuration --------------------------------------------------- |
---|
33 | |
---|
34 | # If your documentation needs a minimal Sphinx version, state it here. |
---|
35 | # |
---|
36 | # needs_sphinx = '1.0' |
---|
37 | |
---|
38 | # Add any Sphinx extension module names here, as strings. They can be |
---|
39 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
---|
40 | # ones. |
---|
41 | extensions = [ |
---|
42 | 'sphinx.ext.todo', |
---|
43 | ] |
---|
44 | |
---|
45 | # Add any paths that contain templates here, relative to this directory. |
---|
46 | templates_path = ['_templates'] |
---|
47 | |
---|
48 | # The suffix(es) of source filenames. |
---|
49 | # You can specify multiple suffix as a list of string: |
---|
50 | # |
---|
51 | # source_suffix = ['.rst', '.md'] |
---|
52 | source_suffix = '.rst' |
---|
53 | |
---|
54 | # The master toctree document. |
---|
55 | master_doc = 'index' |
---|
56 | |
---|
57 | # The language for content autogenerated by Sphinx. Refer to documentation |
---|
58 | # for a list of supported languages. |
---|
59 | # |
---|
60 | # This is also used if you do content translation via gettext catalogs. |
---|
61 | # Usually you set "language" from the command line for these cases. |
---|
62 | language = None |
---|
63 | |
---|
64 | # List of patterns, relative to source directory, that match files and |
---|
65 | # directories to ignore when looking for source files. |
---|
66 | # This pattern also affects html_static_path and html_extra_path. |
---|
67 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
---|
68 | |
---|
69 | # The name of the Pygments (syntax highlighting) style to use. |
---|
70 | pygments_style = None |
---|
71 | |
---|
72 | |
---|
73 | # -- Options for HTML output ------------------------------------------------- |
---|
74 | |
---|
75 | # The theme to use for HTML and HTML Help pages. See the documentation for |
---|
76 | # a list of builtin themes. |
---|
77 | # |
---|
78 | html_theme = 'alabaster' |
---|
79 | |
---|
80 | # Theme options are theme-specific and customize the look and feel of a theme |
---|
81 | # further. For a list of options available for each theme, see the |
---|
82 | # documentation. |
---|
83 | # |
---|
84 | # html_theme_options = {} |
---|
85 | |
---|
86 | # Add any paths that contain custom static files (such as style sheets) here, |
---|
87 | # relative to this directory. They are copied after the builtin static files, |
---|
88 | # so a file named "default.css" will overwrite the builtin "default.css". |
---|
89 | html_static_path = ['_static'] |
---|
90 | |
---|
91 | # Custom sidebar templates, must be a dictionary that maps document names |
---|
92 | # to template names. |
---|
93 | # |
---|
94 | # The default sidebars (for documents that don't match any pattern) are |
---|
95 | # defined by theme itself. Builtin themes are using these templates by |
---|
96 | # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', |
---|
97 | # 'searchbox.html']``. |
---|
98 | # |
---|
99 | # html_sidebars = {} |
---|
100 | |
---|
101 | |
---|
102 | # -- Options for HTMLHelp output --------------------------------------------- |
---|
103 | |
---|
104 | # Output file base name for HTML help builder. |
---|
105 | htmlhelp_basename = 'OpenWorkoutsdoc' |
---|
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, 'OpenWorkouts.tex', 'OpenWorkouts Documentation', |
---|
133 | 'Borja Lopez Rio', '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, 'openworkouts', 'OpenWorkouts 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, 'OpenWorkouts', 'OpenWorkouts Documentation', |
---|
154 | author, 'OpenWorkouts', 'One line description of project.', |
---|
155 | 'Miscellaneous'), |
---|
156 | ] |
---|
157 | |
---|
158 | |
---|
159 | # -- Options for Epub output ------------------------------------------------- |
---|
160 | |
---|
161 | # Bibliographic Dublin Core info. |
---|
162 | epub_title = project |
---|
163 | |
---|
164 | # The unique identifier of the text. This can be a ISBN number |
---|
165 | # or the project homepage. |
---|
166 | # |
---|
167 | # epub_identifier = '' |
---|
168 | |
---|
169 | # A unique identification for the text. |
---|
170 | # |
---|
171 | # epub_uid = '' |
---|
172 | |
---|
173 | # A list of files that should not be packed into the epub file. |
---|
174 | epub_exclude_files = ['search.html'] |
---|
175 | |
---|
176 | |
---|
177 | # -- Extension configuration ------------------------------------------------- |
---|
178 | |
---|
179 | # -- Options for todo extension ---------------------------------------------- |
---|
180 | |
---|
181 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
---|
182 | todo_include_todos = True |
---|