Complete API documentation?

[Juan Luis Cano Rodríguez]

Hi folks! Today I was looking for the definition of the `.. toctree` directive in Sphinx, and finally found it here:

https://github.com/sphinx-doc/sphinx/blob/4bf43984b2dd2dff8fb042711ee35e4a180819b6/sphinx/directives/other.py#L41-L45

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,

jua...@readthedocs.org

Read the Docs

[Komiya Takeshi]

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.

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree

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]

All clear, thanks Takeshi!

Cheers,

jua...@readthedocs.org

Read the Docs

To view this discussion on the web, visit https://groups.google.com/d/msgid/sphinx-dev/CAFmkQAN6QKgnn1eVxTqruXFMg2g22ivHwWr%3DD9SnCwvnRwyFXQ%40mail.gmail.com.