This documentation is hosted at https://docs.pypi.org/ to provide user-facing documentation for using PyPI.

Documentation is written in Markdown and built using mkdocs.

The documentation is built and deployed with readthedocs.org.

See our .readthedocs.yml for configuration.

After following the installation instructions all the remaining commands take place in containers.

The project can be previewed by running docker compose up user-docs from the base directory of your clone of pypa/warehouse. This will start a mkdocs development server that will live reload as you change the contents of this directory, including the mkdocs.yml configuration.