|
11 | 11 | # All configuration values have a default; values that are commented out |
12 | 12 | # serve to show the default. |
13 | 13 |
|
14 | | -import sys, os |
| 14 | +"""python-stdnum documentation build configuration.""" |
15 | 15 |
|
16 | 16 | import stdnum |
17 | 17 |
|
18 | | -# If extensions (or modules to document with autodoc) are in another directory, |
19 | | -# add these directories to sys.path here. If the directory is relative to the |
20 | | -# documentation root, use os.path.abspath to make it absolute, like shown here. |
21 | | -#sys.path.insert(0, os.path.abspath('..')) |
22 | 18 |
|
23 | 19 | # -- General configuration ----------------------------------------------------- |
24 | 20 |
|
25 | | -# If your documentation needs a minimal Sphinx version, state it here. |
26 | | -#needs_sphinx = '1.0' |
27 | | - |
28 | 21 | # Add any Sphinx extension module names here, as strings. They can be extensions |
29 | 22 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
30 | 23 | extensions = [ |
31 | | - 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', |
32 | | - 'sphinx.ext.coverage', 'sphinx.ext.autosummary' |
| 24 | + 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', |
| 25 | + 'sphinx.ext.coverage', 'sphinx.ext.autosummary', |
33 | 26 | ] |
34 | 27 |
|
35 | 28 | # Add any paths that contain templates here, relative to this directory. |
|
46 | 39 |
|
47 | 40 | # General information about the project. |
48 | 41 | project = u'python-stdnum' |
49 | | -copyright = u'2013-2019, Arthur de Jong' |
| 42 | +copyright = u'2013-2023, Arthur de Jong' |
50 | 43 |
|
51 | 44 | # The version info for the project you're documenting, acts as replacement for |
52 | 45 | # |version| and |release|, also used in various other places throughout the |
|
57 | 50 | # The full version, including alpha/beta/rc tags. |
58 | 51 | release = version |
59 | 52 |
|
60 | | -# The language for content autogenerated by Sphinx. Refer to documentation |
61 | | -# for a list of supported languages. |
62 | | -#language = None |
63 | | - |
64 | | -# There are two options for replacing |today|: either, you set today to some |
65 | | -# non-false value, then it is used: |
66 | | -#today = '' |
67 | | -# Else, today_fmt is used as the format for a strftime call. |
68 | | -#today_fmt = '%B %d, %Y' |
69 | | - |
70 | 53 | # List of patterns, relative to source directory, that match files and |
71 | 54 | # directories to ignore when looking for source files. |
72 | 55 | exclude_patterns = ['_*', '.svn', '.git'] |
73 | 56 |
|
74 | | -# The reST default role (used for this markup: `text`) to use for all documents. |
75 | | -#default_role = None |
76 | | - |
77 | | -# If true, '()' will be appended to :func: etc. cross-reference text. |
78 | | -#add_function_parentheses = True |
79 | | - |
80 | | -# If true, the current module name will be prepended to all description |
81 | | -# unit titles (such as .. function::). |
82 | | -#add_module_names = True |
83 | | - |
84 | | -# If true, sectionauthor and moduleauthor directives will be shown in the |
85 | | -# output. They are ignored by default. |
86 | | -#show_authors = False |
87 | | - |
88 | 57 | # The name of the Pygments (syntax highlighting) style to use. |
89 | 58 | pygments_style = 'sphinx' |
90 | 59 |
|
91 | 60 | # A list of ignored prefixes for module index sorting. |
92 | | -modindex_common_prefix = ['stdnum.', ] |
| 61 | +modindex_common_prefix = ['stdnum.'] |
93 | 62 |
|
94 | 63 | # Automatically generate stub pages for autosummary entries. |
95 | 64 | autosummary_generate = True |
|
103 | 72 | # a list of builtin themes. |
104 | 73 | html_theme = 'default' |
105 | 74 |
|
106 | | -# Theme options are theme-specific and customize the look and feel of a theme |
107 | | -# further. For a list of options available for each theme, see the |
108 | | -# documentation. |
109 | | -#html_theme_options = {} |
110 | | - |
111 | | -# Add any paths that contain custom themes here, relative to this directory. |
112 | | -#html_theme_path = [] |
113 | | - |
114 | | -# The name for this set of Sphinx documents. If None, it defaults to |
115 | | -# "<project> v<release> documentation". |
116 | | -#html_title = None |
117 | | - |
118 | | -# A shorter title for the navigation bar. Default is the same as html_title. |
119 | | -#html_short_title = None |
120 | | - |
121 | | -# The name of an image file (relative to this directory) to place at the top |
122 | | -# of the sidebar. |
123 | | -#html_logo = None |
124 | | - |
125 | | -# The name of an image file (within the static path) to use as favicon of the |
126 | | -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
127 | | -# pixels large. |
128 | | -#html_favicon = None |
129 | | - |
130 | | -# Add any paths that contain custom static files (such as style sheets) here, |
131 | | -# relative to this directory. They are copied after the builtin static files, |
132 | | -# so a file named "default.css" will overwrite the builtin "default.css". |
133 | | -#html_static_path = ['_static'] |
134 | | - |
135 | 75 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
136 | 76 | # using the given strftime format. |
137 | 77 | html_last_updated_fmt = '%Y-%m-%d' |
138 | 78 |
|
139 | | -# If true, SmartyPants will be used to convert quotes and dashes to |
140 | | -# typographically correct entities. |
141 | | -#html_use_smartypants = True |
142 | | - |
143 | | -# Custom sidebar templates, maps document names to template names. |
144 | | -#html_sidebars = {} |
145 | | - |
146 | | -# Additional templates that should be rendered to pages, maps page names to |
147 | | -# template names. |
148 | | -#html_additional_pages = {} |
149 | | - |
150 | | -# If false, no module index is generated. |
151 | | -#html_domain_indices = True |
152 | | - |
153 | | -# If false, no index is generated. |
154 | | -#html_use_index = True |
155 | | - |
156 | | -# If true, the index is split into individual pages for each letter. |
157 | | -#html_split_index = False |
158 | | - |
159 | 79 | # If true, links to the reST sources are added to the pages. |
160 | 80 | html_show_sourcelink = False |
161 | 81 |
|
162 | | -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
163 | | -#html_show_sphinx = True |
164 | | - |
165 | | -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
166 | | -#html_show_copyright = True |
167 | | - |
168 | | -# If true, an OpenSearch description file will be output, and all pages will |
169 | | -# contain a <link> tag referring to it. The value of this option must be the |
170 | | -# base URL from which the finished HTML is served. |
171 | | -#html_use_opensearch = '' |
172 | | - |
173 | | -# This is the file name suffix for HTML files (e.g. ".xhtml"). |
174 | | -#html_file_suffix = None |
175 | | - |
176 | | -# Suffix for generated links to HTML files. |
177 | | -#html_link_suffix = '' |
178 | | - |
179 | 82 | # Output file base name for HTML help builder. |
180 | 83 | htmlhelp_basename = 'python-stdnumdoc' |
181 | 84 |
|
|
186 | 89 | # (source start file, name, description, authors, manual section). |
187 | 90 | man_pages = [ |
188 | 91 | ('index', 'python-stdnum', u'python-stdnum Documentation', |
189 | | - [u'Arthur de Jong'], 1) |
| 92 | + [u'Arthur de Jong'], 1), |
190 | 93 | ] |
191 | 94 |
|
192 | | -# If true, show URL addresses after external links. |
193 | | -#man_show_urls = False |
194 | | - |
195 | 95 | intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} |
0 commit comments