sphinx - 1/2 ==> Blog notebook (8) sphinx (13)
sphinx - 1/2¶
Issue with sphinx and pybind11¶
2020-08-10
The kind of nightmare I don’t like spending time on: [Regression] KeyError on pybind11-generated wrappers with Sphinx 3.2.
Check RST syntax¶
2018-04-21
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 .. runpython::
(see RunPythonDirective)
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 :
test_doc_page.
I modify the page name when I have some doubt or I move to
another one.
Long names on Windows¶
2018-03-26
One of my unit test was failing due to a weird error in sphinx-gallery. The module could not write a file on Windows because its name was longer than 260 which still seems to be a limit of the system.
…
Sphinx extensions in pyquickhelper¶
2016-04-04
Sphinx extensions implemented were move to a dedicated subfolder sphinxext:
…
Share buttons on a page from the documenation.¶
2016-02-14
pyquickhelper now includes a directive and a role to share
a page from the documentation on networks.
See ShareNetDirective
and sharenet_role.
The syntax is the following:
...
Bigger text in the documentation¶
2016-02-14
pyquickhelper now includes a role bigger which make a text bigger
...
Sphinx extensions¶
2015-12-12
The following repository birkenfeld/sphinx-contrib/ contains many useful extensions to improve the rendering of Sphinx documentation:
…
Python code to generate part of sphinx documentation¶
2015-12-12
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
RunPythonDirective
which does the same with more options:
...
Local contents in Sphinx¶
2015-12-05
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¶
2015-10-10
Sphinx generates many warning when it builds the documentation despite the fact the result looks good. Some cases.
…
sphinx - 1/2 ==> 2020-08 (2) 2020-09 (1) 2021-01 (1) 2022-03 (1) 2023-05 (1)
