https://github.com/python/docs-community

Community management for documentation contributors and the Docs Workgroup
https://github.com/python/docs-community

Last synced: 9 months ago
JSON representation

Community management for documentation contributors and the Docs Workgroup

• Host: GitHub
• URL: https://github.com/python/docs-community
• Owner: python
• License: cc0-1.0
• Created: 2021-04-16T18:19:40.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-21T09:56:11.000Z (about 1 year ago)
• Last Synced: 2024-10-29T16:06:41.767Z (about 1 year ago)
• Language: Makefile
• Homepage: https://docs-community.readthedocs.io/en/latest/
• Size: 2.5 MB
• Stars: 44
• Watchers: 60
• Forks: 24
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Python Documentation Community

[![Documentation Status](https://readthedocs.org/projects/docs-community/badge/?version=latest)](https://docs-community.readthedocs.io/en/latest/?badge=latest)

[![Python Discourse Documentation Category](https://img.shields.io/badge/discourse-join_chat-brightgreen.svg)](https://discuss.python.org/c/documentation/26)

  

  

  

1. Editorial Board (Approved in 2023 by Steering Council and described in

   [PEP 732](https://peps.python.org/pep-0732/))


   Referred to as Editorial Board or EB


   Repo: [python/editorial-board](https://github.com/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](https://github.com/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](https://docs-community.readthedocs.io/en/latest/).

## Build docs and view changes

1. Clone this repo

   ```console

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

   cd docs-community

   ```

2. Create a new Python virtual environment

   ```console

   python -m venv docs-wg-env

   ```

3. Activate the environment ([platform/shell-specific](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments))

4. Install dependencies

   ```console

   python -m pip install -r requirements.txt

   ```

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

   ```console

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

   ```