diff options
author | Martin Fischer <martin@push-f.com> | 2022-02-10 09:17:18 +0100 |
---|---|---|
committer | Martin Fischer <martin@push-f.com> | 2022-02-10 09:19:47 +0100 |
commit | 091d3f39435da9de77d0492686acd7bba6f79357 (patch) | |
tree | 4831e40e3a6dcb92bb8cba568b78a7400e7b2e48 /README.md | |
parent | 03a1c05a195f83868af94adeb9b405f169098465 (diff) |
merge CONTRIBUTING.md into README.md
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 19 |
1 files changed, 19 insertions, 0 deletions
@@ -9,7 +9,26 @@ often is not structured after the Python modules. 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/ |