Skip to content

Commit 8f89d42

Browse files
authored
doc: Clean up and modernize Sphinx configuration (fixes #463) (#465)
* Switch from setuptools' pkg_resources to importlib.metadata. The remaining changes are based on a fresh invocation of sphinx-quickstart (version 7.2.6), trying to format our existing modifications in the same style. * Update string literals to assume UTF-8 default. * Remove commented Sphinx configuration options. * Remove Sphinx options which are at their default. * Reorder, project settings first. * Remove explanatory comments on configuration options. * Include section headers as generated via sphinx-quickstart. * Remove default HTML theme option. * Reorder (sort) extensions. * Fix undefined default language. * Rename modernized Sphinx options. * Clean up section headings and move autodoc option down. * Import Makefile generated by sphinx-quickstart.
1 parent 3600880 commit 8f89d42

File tree

2 files changed

+60
-301
lines changed

2 files changed

+60
-301
lines changed

doc/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

0 commit comments

Comments
 (0)