betteridiot/docs-community

Community management for documentation contributors and the Docs Workgroup

Python Documentation Community

The Python Documentation Working Group (Docs WG) was created and accepted by the Python Steering Council in 2021 to help bootstrap a larger documentation team and community.

This repo serves as documentation for the Docs WG, which is funny, in a recursive kind of way.

For example, to find out more about us and what we do, read the docs.

Build docs and view changes

1. Clone this repo

   git clone https://github.com/python/docs-community.git
   cd docs-community

2. Create a new Python virtual environment

   python -m venv docs-wg-env

3. Activate the environment (platform/shell-specific)

4. Install dependencies

   python -m pip install -r requirements.txt

5. Build the docs, open them in your browser and update whenever changes are made

   sphinx-autobuild --open-browser docs docs/_build