File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -20,9 +20,18 @@ Sphinx_ is a very common documentation format in the Python world and beyond.
2020``doc2dash `` offers two approaches to parsing it.
2121The preferable one is used whenever a machine-readable intersphinx _ index file is present and it results in very precise and reliable parsing.
2222
23- If none is found, ``doc2dash `` attempts to parse the HTML API index file (``genindex.html `` or ``genindex-all.html ``).
23+ If none is found, ``doc2dash `` attempts to parse the HTML API index file (``genindex.html `` or ``genindex-all.html ``).
2424Simply point ``doc2dash `` at Sphinx's HTML output (usually ``_build/html `` if you built it yourself) and it will do the right thing.
2525
26+ Building Sphinx documentation is usually easy:
27+ after installing the ``sphinx `` package, ``cd `` into their documentation directory (usually ``docs `` or ``doc ``) and enter ``make html ``.
28+
29+ .. warning ::
30+
31+ Do **not ** attempt to run ``doc2dash `` over pre-built HTML documentation downloaded from Read The Docs.
32+ Those downloads aren't direct equivalents of the actual, pristine builds and indexing will not work.
33+
34+
2635
2736.. _pydoctor-sec :
2837
You can’t perform that action at this time.
0 commit comments