[docs] Sphinx indexing
anatoly techtonik
techtonik at gmail.com
Sun Jun 6 16:35:51 CEST 2010
I've stumbled upon definition of `open` function in
http://docs.python.org/genindex-O.html
and I wonder - why none of the following entries leads to definition of `open`?
open
built-in function, [1]
I see that linked paragraphs have explicit `builtin: open` markup, but
can't find their intended
usage in Sphinx documentation. To me the index should look like:
open (built-in function)
Files
Reading and Writing Files
or
open (built-in function)
definition
[1] Files
[2] Reading and Writing Files
or
open (built-in function)
definition
references [1], [2]
Another issue that paragraph anchors generate links that lead to
paragraph contents while
in most cases it would be more helpful to read paragraph title, which
is scrolled offscreen.
--
anatoly t.
More information about the docs
mailing list