pypiserver/docs

pypiserver docs

Welcome to the documentation section of pypiserver.

💡 This documentation is still a work in progress and would benefit from your help.

More information

If something is missing in the documentation here, maybe it is covered in README.rst.

Documentation setup

Some areas to describe are highlighted in this issue (#368), but feel free to add if you see something missing there.

The ./contents directory is designed to all the documentation files.

How to contribute

Everyone is very welcome to extend pypiserver documentation.

1. 💭 If you think of a topic you would like to describe, this is great.
2. 🌳 Fork this project and clone it locally to start your contribution.
3. 📄 Create a new Markdown (<doc title>.md) file/subdirectory+file inside the ./contents:
   • 📁 Use subdirectories to organize related documentation into topics.
4. :octocat: Push your changes to your fork and open a PR to this repository.
5. 🔔 Tag someone from the maintainers if you'd like, but in any case we will try to review the PR as soon as possible.
6. 💫 Once reviewed and accepted, your documentation will be merged into this repository.