Documentation Community Team Meeting (March 2023)

• Date: 2023-03-06

• Time: 20:00 UTC

• This HackMD: https://hackmd.io/@encukou/pydocswg1

• Discourse thread (for March)

• Meeting reports (the latest one might be an unmerged PR)

• Calendar event: (send your e-mail to Mariatta for an invitation)

• How to participate:

  • Go to Google Meet and ask to be let in.

  • To edit notes, click the “pencil” or “split view” button on the HackMD document. You need to log in (e.g. with a GitHub account).

By participating in this meeting, you are agreeing to abide by and uphold the PSF Code of Conduct. Please take a second to read through it!

Roll call

(Name / @GitHubUsername)

• Petr Viktorin / @encukou

• Ezio Melotti / @ezio-melotti

• Ege Akman / @egeakman

• C.A.M. Gerlach / @CAM-Gerlach

• Ryan Duve / @ryan-duve

• Paul Hoffman / @paulehoffman

• Hugo van Kemenade / @hugovk

• Pradyun Gedam / pradyunsg

Reports and celebrations

60 second updates on things you have been up to, questions you have, or developments you think people should know about. Please add yourself, and if you do not have an update to share, you can pass.

This is a place to make announcements (without a need for discussion). This is also a great place to give shout-outs to contributors! We’ll read through these at the beginning of the meeting.

• Hugo: Automatically edit PRs with link to RTD preview

  • python/devguide#1061

  • python/docs-community#74

  • python/peps#3031

  • TODO: Hugo to cleanup the Netlify action so we can transfer to the Python org

• Hugo: Append a hash ?digest to CSS files for cache-busting

  • python/devguide#1054

  • python/python-docs-theme#108

Discussion

• Netlify previews

‘Internal’ items

For and about the Community or Working Group

• Overhaul Building the Documentation section for clarity

  • python/devguide#1038

  • merged

• python/devguide#1020: Function signatures in docs (positional-only markers, defaults, [] syntax)

  • How discoverable is the [] syntax to today’s devs?

Python Project Documentation

Relating to docs.python.org, peps.python.org, devguide.python.org, etc.

• Dark theme for docs.python.org

  • (Hugo) PR looks ready to merge: python/python-docs-theme#44

  • Preview

  • TODO: Hugo open an issue to ask for a release with pending bugfixes, followed by another with dark theme for easy rollback if needed

• Lutra! Improving the bus factor, accessibility and next steps?

• Move PEP 636 (Structural Pattern Matching: Tutorial) to main docs

  • See Discourse thread

• concurrent.futures reorganization

  • See Diataxis website and Diataxis workshop videos for more information on organization

• Sphinx warnings on CI: hugovk/cpython#43

  • Build on Petr’s python/cpython#21

  • show Sphinx warnings in changed files, can’t fail

  • show Sphinx warnings in required-list (e.g. What’s New in 3.12), can fail

  • TODO: Hugo to PR this upstream

PEP Workflow

• Final PEPs and the canonical docs banner link: in PR python/peps#2992

• PEP 1 rewrite?

• Status for PEP 659 and other obsolete PEPs?

Next meeting

The docs team generally meets on the first Monday of every month.

We have a recurring Google Calendar event for the meeting. Let Mariatta know your email address and she can invite you.