Sometimes, the list of entries on a single page gets very long. For quick navigation, you may either add a table of contents or collapse all content. In order to do so, add the following line to your layout.html template: {% set script_files = script_files + [pathto("_static/collapse.js", 1)] %} Now […]
sphinx
5 posts
If you’re not using autodoc, building a list of all your documented classes is not that straightforward. Unfortunately, sphinx does not offer any method to embed this list into your documentation. Below, you find a snippet that creates a sorted list of all classes. Here is what the result looks […]
When using the todo extension of sphinx, I get lines like Todo: configureable random number generator (The original entry is located in /home/ferchault/svndir/colago/lib/colago.rst, line 322.) As the path itself may vary from machine to machine, the absolute path is rather pointless in this setup. Unfortunately, the extension itself has no […]
In some cases, you may want to make your documentation available online. Personally, I don’t like building the documentation at three places: in the office, on my notebook and on my machine at home. Hence, I played around with subversion. Here is the post-commit hook: #!/bin/sh DIR=$(mktemp --directory) REPOS="$1" TXN="$2" […]
When using doxygen together with sphinx via breathe, you may encounter this error Exception occurred: File "/usr/lib/python2.7/xml/dom/expatbuilder.py", line 207, in parseFile parser.Parse(buffer, 0) ExpatError: not well-formed (invalid token): line 963, column 201 It took me some time to figure out what the error behind this message is supposed to be. […]