Documentation Community Team Meeting (February 2023)#
Time: 20:00 UTC
This HackMD: https://hackmd.io/@encukou/pydocswg1
Discourse thread (for February)
Calendar event: (send your e-mail to Mariatta for an invitation)
How to participate:
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!
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.
devguide: Release cycle chart generated directly as SVG python/devguide#1034
PEP Pull Request templates are live. The feature needs some more polish from GitHub’s side to be fully useful
CAM’s script for keeping What’s New versions in sync is almost ready!
PEPs infra: relative links to ease development #2972, remove feedgen/lxml dependency to test Python 3.12-dev #2973, use dark grey instead of dark green for dark theme background #2977, use consistent ‘make html’ and ‘make dirhtml’ #2968 and ‘make htmlview’
Pradyun has a PR, python/peps#2992 on review to make the banners sticky; should be almost ready to go pending a few minor tweaks to browser-specific issues
For and about the Community or Working Group
Trouble installing Python: https://firstname.lastname@example.org/thread/I7JDNUYWIZ3QVY33IDYWFKDTZMIPIVNS/
Overhaul Building the Documentation section for clarity
python/devguide#1020: Function signatures in docs (positional-only markers, defaults,
How discoverable is the
syntax to today’s devs?
The docs mailing list (email@example.com)
Release cycle chart in the Devguide
Possible next steps:
Use inline CSS
Put in individual release dates
draft: Previews in pull requests #105 - need to set up RTD https://github.com/python/python-docs-theme/pull/105
Mariatta to set up an organization account on Read the Docs
Python Project Documentation#
@CAM-Gerlach to improve the glossary. It can then be linked or copied to CPython docs.
improved glossary is part of PEP 639
Improve SEO for CPython docs#
(Hugo) OpenGraph metadata PRs:
About the extension creating social media cards, asked Ee and Julien about deploying all the images in https://github.com/python/docsbuild-scripts/issues/147
Hugo: I suggest we disable the images when available, then enable after testing the points raised in the issue (only enable for web docs, check translations, don’t include in archives)
(Hugo) I find the Google font, small size and tight spacing hard to read. The Google font loading causes a big initial layout shift. Trying it out with default fonts and spacing feels more readable, faster loads.
Originally discussed https://discuss.python.org/t/styling-of-peps/13270/34
CPython docs styling is waiting for Lutra docs
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.