Documentation Community Team Meeting (January 9, 2023)¶
Roll call¶
(Name / @GitHubUsername)
Petr Viktorin /
@encukouJim DeLaHunt /
@JDLH(a conflict in real life took him away for 20 minutes)Mariatta /
@mariattaHugo van Kemenade /
@hugovkC.A.M. Gerlach /
@CAM-Gerlach
Quick updates - Introductions¶
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.
(Hugo) SEO improvements. Using Sphinx extension that generate images for every single page that we have. But it is too heavy for CPython docs (40 MBs and nearly 500 images), using Matplotlib to do it, which is pretty heavy library. Contributors shouldn’t need to be installing this additional library, so we need to find solutions. The extra SEO images should only be generated when publishing CPython docs, and not for building locally. There should be an option to do it.
Check with Ee re. the file sizes
(CAM) PR for PEPs PR templates submitted: python/peps#2956
(CAM) What’s New issues.
python/cpython#100734 Syncing changelog/What’s New between versions
CAM will sync things manually for now, we might want some automation in the future
Would be good to note the Git commands in the RM checklist (PEP 101)
Reports and celebrations¶
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.
Mariatta will be giving a talk about “Contributing to Python” tomorrow; will cover Docs contribution for sure.
Discussion¶
‘Internal’ items¶
For and about the Community or Working Group
Time for the meeting
Let’s alternate the Monday slot with another time, so other people can join?
This is probably not the best audience :)
Python Project Documentation¶
The docs mailing list:
I’m referring to docs@python.org
This is linked from docs.python.org from “report a bug” section
Devguide, PEPs, workflow, etc.¶
Release cycle chart in the Devguide
Followup: @CAM-Gerlach opened devguide issues for adding the additional development phase transition dates python/devguide#998 & a table of individual minor versions python/devguide#999
Petr is (slowly) working on generating the chart by Python
python/devguide#1020: Function signatures in docs (positional-only markers, defaults,
[]syntax)