aboutsummaryrefslogtreecommitdiffstats
path: root/docs/sphinx/nikola_titles_for_sphinx.py
diff options
context:
space:
mode:
Diffstat (limited to 'docs/sphinx/nikola_titles_for_sphinx.py')
-rw-r--r--docs/sphinx/nikola_titles_for_sphinx.py32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/sphinx/nikola_titles_for_sphinx.py b/docs/sphinx/nikola_titles_for_sphinx.py
new file mode 100644
index 0000000..06b76dc
--- /dev/null
+++ b/docs/sphinx/nikola_titles_for_sphinx.py
@@ -0,0 +1,32 @@
+import sphinx.parsers
+from docutils.statemachine import StringList
+from typing import TYPE_CHECKING, Any, Dict, List, Type, Union
+
+if TYPE_CHECKING:
+ from sphinx.application import Sphinx
+
+TITLE_MARKER = ".. title:"
+
+
+class NikolaTitlesRSTParser(sphinx.parsers.RSTParser):
+ def decorate(self, content: StringList) -> None:
+ """Preprocess reST content before parsing."""
+ super().decorate(content)
+ for line in content[:20]:
+ if line.startswith(TITLE_MARKER):
+ title = line[len(TITLE_MARKER) :].strip()
+ fence = "=" * len(title)
+ content.insert(0, "", "<generated>", 0)
+ content.insert(0, fence, "<generated>", 0)
+ content.insert(0, title, "<generated>", 0)
+ content.insert(0, fence, "<generated>", 0)
+
+
+def setup(app: "Sphinx") -> Dict[str, Any]:
+ app.add_source_parser(NikolaTitlesRSTParser, override=True)
+
+ return {
+ "version": "0.1.0",
+ "parallel_read_safe": True,
+ "parallel_write_safe": True,
+ }