Supported Input Formats¶
doc2dash supports two documentation formats:
Feel free to help adding more! While
doc2dash is implemented in Python, the scope for the supported documentation types is unlimited.
Sphinx is a very common documentation format in the Python world and beyond.
Building Sphinx documentation is usually easy:
after installing the
cd into their documentation directory (usually
doc) and enter
Do not attempt to run
doc2dash over pre-built HTML documentation downloaded from Read The Docs.
Those downloads aren’t direct equivalents of the actual, pristine builds and indexing will not work.
Contrary to Sphinx, pydoctor is not a complete documentation format. Instead, it’s focused on creating API documentation from Python docstrings. The most popular project employing is Twisted and its ecosystem.
Since pydoctor alas does not emit a machine-readable file, the
nameIndex.html is parsed.
Fortunately, no theming is common in the pydoctor world, so the parsing is reliable nonetheless.