unique-usman/docs-community

Community management for documentation contributors and the Docs Workgroup

Python Documentation Community

1. Editorial Board (Approved in 2023 by Steering Council and described in PEP 732)
   Referred to as Editorial Board or EB
   Repo: python/editorial-board
2. Documentation Community Group (Working Group created in 2021 by the Python Steering Council)
   Referred to as the Documentation Community or docs-community
   Repo: python/docs-community
3. Users of Python Documentation

This repo serves as documentation for the Documentation Community Group.

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