Skip to content

Commit 7bf9aa9

Browse files
committed
Clarify how to build Sphinx docs
Also warn from RTD-downloaded documentation.
1 parent 3fe01bc commit 7bf9aa9

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

docs/formats.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff 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.
2121
The 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``).
2424
Simply 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

0 commit comments

Comments
 (0)