]> git.madduck.net Git - etc/vim.git/blob - docs/conf.py

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

908a1a7e69250b0579ccfa48f306b1e615278d9e
[etc/vim.git] / docs / conf.py
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/stable/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 ast
16 from pathlib import Path
17 import re
18 import shutil
19 import string
20
21 from recommonmark.parser import CommonMarkParser
22
23
24 CURRENT_DIR = Path(__file__).parent
25
26
27 def get_version():
28     black_py = CURRENT_DIR / '..' / 'black.py'
29     _version_re = re.compile(r'__version__\s+=\s+(?P<version>.*)')
30     with open(str(black_py), 'r', encoding='utf8') as f:
31         version = _version_re.search(f.read()).group('version')
32     return str(ast.literal_eval(version))
33
34
35 def make_pypi_svg(version):
36     template = CURRENT_DIR / '_static' / 'pypi_template.svg'
37     target = CURRENT_DIR / '_static' / 'pypi.svg'
38     with open(str(template), 'r', encoding='utf8') as f:
39         svg = string.Template(f.read()).substitute(version=version)
40     with open(str(target), 'w', encoding='utf8') as f:
41         f.write(svg)
42
43
44 def make_filename(line):
45     non_letters = re.compile(r'[^a-z]+')
46     filename = line[3:].rstrip().lower()
47     filename = non_letters.sub('_', filename)
48     if filename.startswith('_'):
49         filename = filename[1:]
50     if filename.endswith('_'):
51         filename = filename[:-1]
52     return filename + '.md'
53
54
55 def generate_sections_from_readme():
56     target_dir = CURRENT_DIR / '_build' / 'generated'
57     readme = CURRENT_DIR / '..' / 'README.md'
58     shutil.rmtree(str(target_dir), ignore_errors=True)
59     target_dir.mkdir(parents=True)
60
61     output = None
62     with open(str(readme), 'r', encoding='utf8') as f:
63         for line in f:
64             if line.startswith('## '):
65                 if output is not None:
66                     output.close()
67                 filename = make_filename(line)
68                 output_path = CURRENT_DIR / filename
69                 if output_path.is_symlink() or output_path.is_file():
70                     output_path.unlink()
71                 output_path.symlink_to(target_dir / filename)
72                 output = open(str(output_path), 'w', encoding='utf8')
73                 output.write(
74                     '[//]: # (NOTE: THIS FILE IS AUTOGENERATED FROM README.md)\n\n'
75                 )
76
77             if output is None:
78                 continue
79
80             if line.startswith('##'):
81                 line = line[1:]
82
83             output.write(line)
84
85
86 # -- Project information -----------------------------------------------------
87
88 project = 'Black'
89 copyright = '2018, Łukasz Langa and contributors to Black'
90 author = 'Łukasz Langa and contributors to Black'
91
92 # Autopopulate version
93 # The full version, including alpha/beta/rc tags.
94 release = get_version()
95 # The short X.Y version.
96 version = release
97 for sp in 'abcfr':
98     version = version.split(sp)[0]
99 make_pypi_svg(release)
100 generate_sections_from_readme()
101
102
103 # -- General configuration ---------------------------------------------------
104
105 # If your documentation needs a minimal Sphinx version, state it here.
106 #
107 # needs_sphinx = '1.0'
108
109 # Add any Sphinx extension module names here, as strings. They can be
110 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
111 # ones.
112 extensions = [
113     'sphinx.ext.autodoc',
114     'sphinx.ext.intersphinx',
115     'sphinx.ext.napoleon',
116 ]
117
118 # Add any paths that contain templates here, relative to this directory.
119 templates_path = ['_templates']
120
121 source_parsers = {
122     '.md': CommonMarkParser,
123 }
124
125 # The suffix(es) of source filenames.
126 # You can specify multiple suffix as a list of string:
127 source_suffix = ['.rst', '.md']
128
129 # The master toctree document.
130 master_doc = 'index'
131
132 # The language for content autogenerated by Sphinx. Refer to documentation
133 # for a list of supported languages.
134 #
135 # This is also used if you do content translation via gettext catalogs.
136 # Usually you set "language" from the command line for these cases.
137 language = None
138
139 # List of patterns, relative to source directory, that match files and
140 # directories to ignore when looking for source files.
141 # This pattern also affects html_static_path and html_extra_path .
142 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
143
144 # The name of the Pygments (syntax highlighting) style to use.
145 pygments_style = 'sphinx'
146
147
148 # -- Options for HTML output -------------------------------------------------
149
150 # The theme to use for HTML and HTML Help pages.  See the documentation for
151 # a list of builtin themes.
152 #
153 html_theme = 'alabaster'
154
155 html_sidebars = {
156     '**': [
157         'about.html',
158         'navigation.html',
159         'relations.html',
160         'sourcelink.html',
161         'searchbox.html'
162     ]
163 }
164
165 html_theme_options = {
166     'show_related': False,
167     'description': '“Any color you like.”',
168     'github_button': True,
169     'github_user': 'ambv',
170     'github_repo': 'black',
171     'github_type': 'star',
172     'show_powered_by': True,
173     'fixed_sidebar': True,
174     'logo': 'logo2.png',
175 }
176
177
178 # Add any paths that contain custom static files (such as style sheets) here,
179 # relative to this directory. They are copied after the builtin static files,
180 # so a file named "default.css" will overwrite the builtin "default.css".
181 html_static_path = ['_static']
182
183 # Custom sidebar templates, must be a dictionary that maps document names
184 # to template names.
185 #
186 # The default sidebars (for documents that don't match any pattern) are
187 # defined by theme itself.  Builtin themes are using these templates by
188 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
189 # 'searchbox.html']``.
190 #
191 # html_sidebars = {}
192
193
194 # -- Options for HTMLHelp output ---------------------------------------------
195
196 # Output file base name for HTML help builder.
197 htmlhelp_basename = 'blackdoc'
198
199
200 # -- Options for LaTeX output ------------------------------------------------
201
202 latex_elements = {
203     # The paper size ('letterpaper' or 'a4paper').
204     #
205     # 'papersize': 'letterpaper',
206
207     # The font size ('10pt', '11pt' or '12pt').
208     #
209     # 'pointsize': '10pt',
210
211     # Additional stuff for the LaTeX preamble.
212     #
213     # 'preamble': '',
214
215     # Latex figure (float) alignment
216     #
217     # 'figure_align': 'htbp',
218 }
219
220 # Grouping the document tree into LaTeX files. List of tuples
221 # (source start file, target name, title,
222 #  author, documentclass [howto, manual, or own class]).
223 latex_documents = [
224     (master_doc, 'black.tex', 'Documentation for Black',
225      'Łukasz Langa and contributors to Black', 'manual'),
226 ]
227
228
229 # -- Options for manual page output ------------------------------------------
230
231 # One entry per manual page. List of tuples
232 # (source start file, name, description, authors, manual section).
233 man_pages = [
234     (master_doc, 'black', 'Documentation for Black',
235      [author], 1)
236 ]
237
238
239 # -- Options for Texinfo output ----------------------------------------------
240
241 # Grouping the document tree into Texinfo files. List of tuples
242 # (source start file, target name, title, author,
243 #  dir menu entry, description, category)
244 texinfo_documents = [
245     (master_doc, 'Black', 'Documentation for Black',
246      author, 'Black', 'The uncompromising Python code formatter',
247      'Miscellaneous'),
248 ]
249
250
251 # -- Options for Epub output -------------------------------------------------
252
253 # Bibliographic Dublin Core info.
254 epub_title = project
255 epub_author = author
256 epub_publisher = author
257 epub_copyright = copyright
258
259 # The unique identifier of the text. This can be a ISBN number
260 # or the project homepage.
261 #
262 # epub_identifier = ''
263
264 # A unique identification for the text.
265 #
266 # epub_uid = ''
267
268 # A list of files that should not be packed into the epub file.
269 epub_exclude_files = ['search.html']
270
271
272 # -- Extension configuration -------------------------------------------------
273
274 # -- Options for intersphinx extension ---------------------------------------
275
276 # Example configuration for intersphinx: refer to the Python standard library.
277 intersphinx_mapping = {'https://docs.python.org/3/': None}