"If you're not on Windows, all it takes is to run make -C Doc venv htmllive to build the Python documentation locally and to preview it. This command will build the documentation, start a local server to browse the docs, and also watch for changes in the documentation source files to live-reload while you edit! I needed this because the Python 3.14 documentation for the module concurrent.interpreters had a terrible-looking "See also" callout with elements that were grossly misaligned:"
"After some Googling, turns out the problem is the comment .. XXX Add references.... Since it's indentend four spaces, it's being interpreted as a blockquote! The fix was just deleting a single space from the left of.. XXX .... However, I did not stop there! I went above and beyond, capitalising the sentences and adding a full stop to the one that didn't have it! In the end, the "See also" callout was looking better:"
Run make -C Doc venv htmllive to build Python documentation locally, start a local server, and enable live-reload while editing. The Python 3.14 concurrent.interpreters module documentation displayed a misaligned "See also" callout. Lack of rST familiarity can make such formatting issues non-obvious to Markdown-only users. The root cause was a commented line starting with ".. XXX" indented four spaces, which rST interpreted as a blockquote. Removing one leading space fixed the rendering. Additional edits capitalised sentences and added a missing full stop, resulting in an improved callout appearance.
Read at Mathspp
Unable to calculate read time
Collection
[
|
...
]