blob: 5c282c25a7b261ed2d8dbd89f5052a6bd3c789fb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
# pydoc.dev - consistent API docs for Python
Looking at the API documentations of Python packages can be a bit disorienting
because they can look different from project to project (since different
projects use different [Sphinx] themes) and because the API documentation
often is not structured after the Python modules.
**pydoc.dev** strives to be for Python what [docs.rs] is for Rust.
It works by downloading the source files from the [Python Package Index],
the API documentation is then generated with [pydoctor].
<!-- package list -->
## How to contribute
* You can give feedback and suggest packages to be included,
either by [email] or in the [#pydoc] IRC channel on [Libera.Chat].
* You can contribute to [pydoctor].
* You can contribute to the individual Python projects
to improve their [docstrings].
* If you want to support pydoc.dev by providing hosting,
[please get in touch][email].
[Sphinx]: https://www.sphinx-doc.org/
[docs.rs]: https://docs.rs/
[Python Package Index]: https://pypi.org/
[pydoctor]: https://github.com/twisted/pydoctor
[email]: mailto:martin@push-f.com
[#pydoc]: https://web.libera.chat/?channel=#pydoc
[Libera.Chat]: https://libera.chat/
[docstrings]: https://www.python.org/dev/peps/pep-0257/
|
