Complete API documentation?

5 views
Skip to first unread message

Juan Luis Cano Rodríguez

unread,
Jul 22, 2021, 6:58:54 AMJul 22
to sphinx-dev
Hi folks! Today I was looking for the definition of the `.. toctree` directive in Sphinx, and finally found it here:


However, even though some objects appear in the API documentation (for example https://www.sphinx-doc.org/en/master/extdev/appapi.html), the `TocTree` class is not one of them.

Is there a deliberate policy of not including some objects in the HTML API documentation (for example, if they are not meant to be extended by users, or if they are not considered "public API"), or would you be open to adding an exhaustive list of all the Python objects somewhere?

Cheers,
Read the Docs

Komiya Takeshi

unread,
Jul 22, 2021, 8:45:25 AMJul 22
to sphin...@googlegroups.com
Hi,

> Is there a deliberate policy of not including some objects in the HTML API documentation (for example, if they are not meant to be extended by users, or if they are not considered "public API"), or would you be open to adding an exhaustive list of all the Python objects somewhere?

IMO, the TocTree class is not a part of "API". I don't think it's not a "programmable" item. So my answer is former one; "they are not meant to be extended by users".

If you're saying that the document of the toctree directive is difficult to understand, I agree with you. It would be nice if we'll improve it.

Thanks,
Takeshi KOMIYA



2021年7月22日(木) 19:58 Juan Luis Cano Rodríguez <juan...@readthedocs.org>:
--
You received this message because you are subscribed to the Google Groups "sphinx-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-dev+...@googlegroups.com.
To view this discussion on the web, visit https://groups.google.com/d/msgid/sphinx-dev/0e56f9fa9d00717d9aab059920c98d8c%40frontapp.com.

Juan Luis Cano Rodríguez

unread,
Jul 22, 2021, 10:17:34 AMJul 22
to sphin...@googlegroups.com
All clear, thanks Takeshi!

Cheers,
Read the Docs

Reply all
Reply to author
Forward
0 new messages