# The Python documentation should borrow the idea from the PHP.net

**URL:** <https://discuss.python.org/t/the-python-documentation-should-borrow-the-idea-from-the-php-net/53335>\
**Category:** Documentation\
**Created:** [May 14, 2024, 7:53pm UTC](https://discuss.python.org/t/the-python-documentation-should-borrow-the-idea-from-the-php-net/53335 "2024-05-14T19:53:55Z")\
**Posts on this page:** 1\
**Showing post:** 11

<div class="post-metadata">

**Author:** ![Nodd](https://sea2.discourse-cdn.com/flex002/user_avatar/discuss.python.org/nodd/32/6805_2.png) [@Nodd](https://discuss.python.org/u/Nodd)\
**Post date:** [May 16, 2024, 9:09am UTC](https://discuss.python.org/t/the-python-documentation-should-borrow-the-idea-from-the-php-net/53335/11 "2024-05-16T09:09:56Z")

</div>

FYI that is also how the numpy documentation is organized (see [Array creation routines — NumPy v1.26 Manual](https://numpy.org/doc/stable/reference/routines.array-creation.html) for example). What I like a lot is the list with a short description, which gives the available API at a quick glance. It’s very useful both for modules and classes.

With the current documentation, I have to scroll the whole page to know what functions are available. I find navigating huge pages a hassle (see for example [Built-in Types — Python 3.12.3 documentation](https://docs.python.org/3/library/stdtypes.html)).

Instead of rewrinting the whole documentation, I think a first step would be to add pages using [`sphinx.ext.autosummary`](https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html#module-sphinx.ext.autosummary), which would link to the existing documentation. I tried to generate those automatically by my result was not that great.

Some module docuemntations already include such tables in the introduction, maybe this could be generalized ? See [statistics — Mathematical statistics functions — Python 3.12.3 documentation](https://docs.python.org/3/library/statistics.html).

I think there are multiple ways to improve the status quo, with different levels of implication and rewriting. I just listed some of them here, I can try to add more details if needed.

---

_[View the full topic](https://discuss.python.org/t/the-python-documentation-should-borrow-the-idea-from-the-php-net/53335)._