]> 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:

575a14011e4bbc2917de9bdc6757cb89baec144b
[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 from pathlib import Path
16 import re
17 import string
18 from typing import Callable, List, Optional, Pattern, Tuple, Set
19 from dataclasses import dataclass
20 import logging
21
22 from pkg_resources import get_distribution
23
24 logging.basicConfig(format="%(levelname)s: %(message)s", level=logging.INFO)
25
26 LOG = logging.getLogger(__name__)
27
28 CURRENT_DIR = Path(__file__).parent
29 README = CURRENT_DIR / ".." / "README.md"
30 REFERENCE_DIR = CURRENT_DIR / "reference"
31 STATIC_DIR = CURRENT_DIR / "_static"
32
33
34 @dataclass
35 class SrcRange:
36     """Tracks which part of a file to get a section's content.
37
38     Data:
39         start_line: The line where the section starts (i.e. its sub-header) (inclusive).
40         end_line: The line where the section ends (usually next sub-header) (exclusive).
41     """
42
43     start_line: int
44     end_line: int
45
46
47 @dataclass
48 class DocSection:
49     """Tracks information about a section of documentation.
50
51     Data:
52         name: The section's name. This will used to detect duplicate sections.
53         src: The filepath to get its contents.
54         processors: The processors to run before writing the section to CURRENT_DIR.
55         out_filename: The filename to use when writing the section to CURRENT_DIR.
56         src_range: The line range of SRC to gets its contents.
57     """
58
59     name: str
60     src: Path
61     src_range: SrcRange = SrcRange(0, 1_000_000)
62     out_filename: str = ""
63     processors: Tuple[Callable, ...] = ()
64
65     def get_out_filename(self) -> str:
66         if not self.out_filename:
67             return self.name + ".md"
68         else:
69             return self.out_filename
70
71
72 def make_pypi_svg(version: str) -> None:
73     template: Path = CURRENT_DIR / "_static" / "pypi_template.svg"
74     target: Path = CURRENT_DIR / "_static" / "pypi.svg"
75     with open(str(template), "r", encoding="utf8") as f:
76         svg: str = string.Template(f.read()).substitute(version=version)
77     with open(str(target), "w", encoding="utf8") as f:
78         f.write(svg)
79
80
81 def make_filename(line: str) -> str:
82     non_letters: Pattern = re.compile(r"[^a-z]+")
83     filename: str = line[3:].rstrip().lower()
84     filename = non_letters.sub("_", filename)
85     if filename.startswith("_"):
86         filename = filename[1:]
87     if filename.endswith("_"):
88         filename = filename[:-1]
89     return filename + ".md"
90
91
92 def get_contents(section: DocSection) -> str:
93     """Gets the contents for the DocSection."""
94     contents: List[str] = []
95     src: Path = section.src
96     start_line: int = section.src_range.start_line
97     end_line: int = section.src_range.end_line
98     with open(src, "r", encoding="utf-8") as f:
99         for lineno, line in enumerate(f, start=1):
100             if lineno >= start_line and lineno < end_line:
101                 contents.append(line)
102     return "".join(contents)
103
104
105 def get_sections_from_readme() -> List[DocSection]:
106     """Gets the sections from README so they can be processed by process_sections.
107
108     It opens README and goes down line by line looking for sub-header lines which
109     denotes a section. Once it finds a sub-header line, it will create a DocSection
110     object with all of the information currently available. Then on every line, it will
111     track the ending line index of the section. And it repeats this for every sub-header
112     line it finds.
113     """
114     sections: List[DocSection] = []
115     section: Optional[DocSection] = None
116     with open(README, "r", encoding="utf-8") as f:
117         for lineno, line in enumerate(f, start=1):
118             if line.startswith("## "):
119                 filename = make_filename(line)
120                 section_name = filename[:-3]
121                 section = DocSection(
122                     name=str(section_name),
123                     src=README,
124                     src_range=SrcRange(lineno, lineno),
125                     out_filename=filename,
126                     processors=(fix_headers,),
127                 )
128                 sections.append(section)
129             if section is not None:
130                 section.src_range.end_line += 1
131     return sections
132
133
134 def fix_headers(contents: str) -> str:
135     """Fixes the headers of sections copied from README.
136
137     Removes one octothorpe (#) from all headers since the contents are no longer nested
138     in a root document (i.e. the README).
139     """
140     lines: List[str] = contents.splitlines()
141     fixed_contents: List[str] = []
142     for line in lines:
143         if line.startswith("##"):
144             line = line[1:]
145         fixed_contents.append(line + "\n")  # splitlines strips the leading newlines
146     return "".join(fixed_contents)
147
148
149 def process_sections(
150     custom_sections: List[DocSection], readme_sections: List[DocSection]
151 ) -> None:
152     """Reads, processes, and writes sections to CURRENT_DIR.
153
154     For each section, the contents will be fetched, processed by processors
155     required by the section, and written to CURRENT_DIR. If it encounters duplicate
156     sections (i.e. shares the same name attribute), it will skip processing the
157     duplicates.
158
159     It processes custom sections before the README generated sections so sections in the
160     README can be overwritten with custom options.
161     """
162     processed_sections: Set[str] = set()
163     modified_files: Set[Path] = set()
164     sections: List[DocSection] = custom_sections
165     sections.extend(readme_sections)
166     for section in sections:
167         LOG.info(f"Processing '{section.name}' from {section.src}")
168         if section.name in processed_sections:
169             LOG.info(
170                 f"Skipping '{section.name}' from '{section.src}' as it is a duplicate"
171             )
172             continue
173
174         target_path: Path = CURRENT_DIR / section.get_out_filename()
175         if target_path in modified_files:
176             LOG.warning(
177                 f"{target_path} has been already written to, its contents will be"
178                 " OVERWRITTEN and notices will be duplicated"
179             )
180         contents: str = get_contents(section)
181
182         # processors goes here
183         if fix_headers in section.processors:
184             contents = fix_headers(contents)
185
186         with open(target_path, "w", encoding="utf-8") as f:
187             if section.src.suffix == ".md":
188                 f.write(
189                     "[//]: # (NOTE: THIS FILE WAS AUTOGENERATED FROM"
190                     f" {section.src})\n\n"
191                 )
192             f.write(contents)
193         processed_sections.add(section.name)
194         modified_files.add(target_path)
195
196
197 # -- Project information -----------------------------------------------------
198
199 project = "Black"
200 copyright = "2020, Łukasz Langa and contributors to Black"
201 author = "Łukasz Langa and contributors to Black"
202
203 # Autopopulate version
204 # The version, including alpha/beta/rc tags, but not commit hash and datestamps
205 release = get_distribution("black").version.split("+")[0]
206 # The short X.Y version.
207 version = release
208 for sp in "abcfr":
209     version = version.split(sp)[0]
210
211 custom_sections = [
212     DocSection("the_black_code_style", CURRENT_DIR / "the_black_code_style.md",),
213     DocSection("editor_integration", CURRENT_DIR / "editor_integration.md"),
214     DocSection("blackd", CURRENT_DIR / "blackd.md"),
215     DocSection("black_primer", CURRENT_DIR / "black_primer.md"),
216     DocSection("contributing_to_black", CURRENT_DIR / ".." / "CONTRIBUTING.md"),
217     DocSection("change_log", CURRENT_DIR / ".." / "CHANGES.md"),
218 ]
219
220 # Sphinx complains when there is a source file that isn't referenced in any of the docs.
221 # Since some sections autogenerated from the README are unused warnings will appear.
222 #
223 # Sections must be listed to what their name is when passed through make_filename().
224 blocklisted_sections_from_readme = {
225     "license",
226     "pragmatism",
227     "testimonials",
228     "used_by",
229 }
230
231 make_pypi_svg(release)
232 readme_sections = get_sections_from_readme()
233 readme_sections = [
234     x for x in readme_sections if x.name not in blocklisted_sections_from_readme
235 ]
236
237 process_sections(custom_sections, readme_sections)
238
239
240 # -- General configuration ---------------------------------------------------
241
242 # If your documentation needs a minimal Sphinx version, state it here.
243 needs_sphinx = "3.0"
244
245 # Add any Sphinx extension module names here, as strings. They can be
246 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
247 # ones.
248 extensions = [
249     "sphinx.ext.autodoc",
250     "sphinx.ext.intersphinx",
251     "sphinx.ext.napoleon",
252     "recommonmark",
253 ]
254
255 # If you need extensions of a certain version or higher, list them here.
256 needs_extensions = {"recommonmark": "0.5"}
257
258 # Add any paths that contain templates here, relative to this directory.
259 templates_path = ["_templates"]
260
261 # The suffix(es) of source filenames.
262 # You can specify multiple suffix as a list of string:
263 source_suffix = [".rst", ".md"]
264
265 # The master toctree document.
266 master_doc = "index"
267
268 # The language for content autogenerated by Sphinx. Refer to documentation
269 # for a list of supported languages.
270 #
271 # This is also used if you do content translation via gettext catalogs.
272 # Usually you set "language" from the command line for these cases.
273 language = None
274
275 # List of patterns, relative to source directory, that match files and
276 # directories to ignore when looking for source files.
277 # This pattern also affects html_static_path and html_extra_path .
278
279 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
280
281 # The name of the Pygments (syntax highlighting) style to use.
282 pygments_style = "sphinx"
283
284
285 # -- Options for HTML output -------------------------------------------------
286
287 # The theme to use for HTML and HTML Help pages.  See the documentation for
288 # a list of builtin themes.
289 #
290 html_theme = "alabaster"
291
292 html_sidebars = {
293     "**": [
294         "about.html",
295         "navigation.html",
296         "relations.html",
297         "sourcelink.html",
298         "searchbox.html",
299     ]
300 }
301
302 html_theme_options = {
303     "show_related": False,
304     "description": "“Any color you like.”",
305     "github_button": True,
306     "github_user": "psf",
307     "github_repo": "black",
308     "github_type": "star",
309     "show_powered_by": True,
310     "fixed_sidebar": True,
311     "logo": "logo2.png",
312     "travis_button": True,
313 }
314
315
316 # Add any paths that contain custom static files (such as style sheets) here,
317 # relative to this directory. They are copied after the builtin static files,
318 # so a file named "default.css" will overwrite the builtin "default.css".
319 html_static_path = ["_static"]
320
321 # Custom sidebar templates, must be a dictionary that maps document names
322 # to template names.
323 #
324 # The default sidebars (for documents that don't match any pattern) are
325 # defined by theme itself.  Builtin themes are using these templates by
326 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
327 # 'searchbox.html']``.
328 #
329 # html_sidebars = {}
330
331
332 # -- Options for HTMLHelp output ---------------------------------------------
333
334 # Output file base name for HTML help builder.
335 htmlhelp_basename = "blackdoc"
336
337
338 # -- Options for LaTeX output ------------------------------------------------
339
340 latex_elements = {
341     # The paper size ('letterpaper' or 'a4paper').
342     #
343     # 'papersize': 'letterpaper',
344     # The font size ('10pt', '11pt' or '12pt').
345     #
346     # 'pointsize': '10pt',
347     # Additional stuff for the LaTeX preamble.
348     #
349     # 'preamble': '',
350     # Latex figure (float) alignment
351     #
352     # 'figure_align': 'htbp',
353 }
354
355 # Grouping the document tree into LaTeX files. List of tuples
356 # (source start file, target name, title,
357 #  author, documentclass [howto, manual, or own class]).
358 latex_documents = [
359     (
360         master_doc,
361         "black.tex",
362         "Documentation for Black",
363         "Łukasz Langa and contributors to Black",
364         "manual",
365     )
366 ]
367
368
369 # -- Options for manual page output ------------------------------------------
370
371 # One entry per manual page. List of tuples
372 # (source start file, name, description, authors, manual section).
373 man_pages = [(master_doc, "black", "Documentation for Black", [author], 1)]
374
375
376 # -- Options for Texinfo output ----------------------------------------------
377
378 # Grouping the document tree into Texinfo files. List of tuples
379 # (source start file, target name, title, author,
380 #  dir menu entry, description, category)
381 texinfo_documents = [
382     (
383         master_doc,
384         "Black",
385         "Documentation for Black",
386         author,
387         "Black",
388         "The uncompromising Python code formatter",
389         "Miscellaneous",
390     )
391 ]
392
393
394 # -- Options for Epub output -------------------------------------------------
395
396 # Bibliographic Dublin Core info.
397 epub_title = project
398 epub_author = author
399 epub_publisher = author
400 epub_copyright = copyright
401
402 # The unique identifier of the text. This can be a ISBN number
403 # or the project homepage.
404 #
405 # epub_identifier = ''
406
407 # A unique identification for the text.
408 #
409 # epub_uid = ''
410
411 # A list of files that should not be packed into the epub file.
412 epub_exclude_files = ["search.html"]
413
414
415 # -- Extension configuration -------------------------------------------------
416
417 autodoc_member_order = "bysource"
418
419 # -- Options for intersphinx extension ---------------------------------------
420
421 # Example configuration for intersphinx: refer to the Python standard library.
422 intersphinx_mapping = {"https://docs.python.org/3/": None}