sphinx - 1/2¶
Check RST syntax¶
It is usually a pain to discover I made an error in a
formula while I’m writing documentation. It fails
quite long after after the unit tests started. The
documentation is generated after the unit test pass.
I also use a lot
to run pieces of code inside the documentation.
It is quite annoying to discover it fails long after.
So I creates a unit test which can be used to compile a
single page of the documentation :
I modify the page name when I have some doubt or I move to
Long names on Windows¶
Sphinx extensions in pyquickhelper¶
Sphinx extensions implemented were move to a dedicated subfolder sphinxext:
Share buttons on a page from the documenation.¶
Bigger text in the documentation¶
pyquickhelper now includes a role bigger which make a text bigger
Python code to generate part of sphinx documentation¶
I used the same title as a question asked on stackoverflow:
Python code to generate part of sphinx documentation, is it possible?.
It became the following
which does the same with more options:
Local contents in Sphinx¶
The Sphinx command contents adds a table of contents to a page. As contents is pretty common, on the web, it is not always easy to search for it:
A few tips with Sphinx¶
Sphinx generates many warning when it builds the documentation despite the fact the result looks good. Some cases.