RSS Planet Python

Rodrigo Girão Serrão: TIL #135 – Build the Python documentation

The author discovered how to build and preview Python documentation locally to review changes. They used the command `make -C Doc venv htmllive` for this purpose, which also offers live-reloading. The author encountered a visual issue in the concurrent.interpreters module's documentation with a misaligned "See also" callout. The problem stemmed from a comment block incorrectly formatted as a blockquote due to indentation. The author, unfamiliar with reStructuredText (rST), initially struggled to identify the root cause. After some research, they discovered that removing a single space from the comment corrected the issue. The author went further to improve the documentation, capitalising the sentences and adding a full stop. This resulted in a significantly better-looking "See also" section, fixing the initial problem. Building and previewing documentation locally was an effective method for identifying and resolving the issue. The author expressed satisfaction with the improved visual presentation.
favicon
mathspp.com
mathspp.com
Image for the article: Rodrigo Girão Serrão: TIL #135 – Build the Python documentation
Create attached notes ...