|
| 1 | +# Documentation Community Team Meeting (February 2025) |
| 2 | + |
| 3 | +- **Date:** 2025-02-04 |
| 4 | +- **Time:** [20:00 UTC](https://arewemeetingyet.com/UTC/2024-11-05/20:00/Docs20Meeting) |
| 5 | +- **This HackMD:** <https://hackmd.io/@encukou/pydocswg1> |
| 6 | +- [**Discourse thread**](https://discuss.python.org/t/documentation-community-meeting-tuesday-4th-february-2025/78750) |
| 7 | + (for February) |
| 8 | +- [**Meeting reports**](https://docs-community.readthedocs.io/en/latest/monthly-meeting/) |
| 9 | + (the latest one might be an |
| 10 | + [**unmerged PR**](https://github.com/python/docs-community/pulls)) |
| 11 | +- **Calendar event:** (send your e-mail to Mariatta for an invitation) |
| 12 | +- **How to participate:** |
| 13 | + - We are using Discord this time: |
| 14 | + <https://discord.gg/ER6Qtc92?event=1323719795702759545> |
| 15 | + - To edit notes, click the “pencil” or “split view” button on the |
| 16 | + [HackMD document](https://hackmd.io/@encukou/pydocswg1). You need to log in (e.g. |
| 17 | + with a GitHub account). |
| 18 | + |
| 19 | +By participating in this meeting, you are agreeing to abide by and uphold the |
| 20 | +[PSF Code of Conduct](https://www.python.org/psf/codeofconduct/). Please take a second |
| 21 | +to read through it! |
| 22 | + |
| 23 | +## Roll call |
| 24 | + |
| 25 | +(Name / `@GitHubUsername` _[/ Discord, if different]_) |
| 26 | + |
| 27 | +- Carol Willing / `@willingc` |
| 28 | +- Petr Viktorin / `@encukou` |
| 29 | +- Daniele |
| 30 | +- Hugo van Kemenade / `@hugovk` |
| 31 | +- Joe Kaufeld / `@itsthejoker` |
| 32 | +- Keith |
| 33 | +- Maciek Olko / `@m-aciek` |
| 34 | +- Adam Turner / `@AA-Turner` |
| 35 | +- Jeff Jacobson |
| 36 | +- Blaise Pabon |
| 37 | +- Stan / `@StanFromIreland` |
| 38 | + |
| 39 | +## Introductions |
| 40 | + |
| 41 | +> If there are any new people, we should do a round of introductions. |
| 42 | +
|
| 43 | +Introductions were made. |
| 44 | + |
| 45 | +## Reports and celebrations |
| 46 | + |
| 47 | +> 60 second updates on things you have been up to, questions you have, or developments |
| 48 | +> you think people should know about. Please add yourself, and if you do not have an |
| 49 | +> update to share, you can pass. |
| 50 | +
|
| 51 | +> This is a place to make announcements (without a need for discussion). This is also a |
| 52 | +> great place to give shout-outs to contributors! We'll read through these at the |
| 53 | +> beginning of the meeting. |
| 54 | +
|
| 55 | +- `python-docs-theme` 2025.2 was released today. |
| 56 | +- We have narrowed supported Sphinx versions to only the latest; Sphinx 8.1. |
| 57 | + [cpython/python#125722](https://github.com/python/cpython/issues/125722) |
| 58 | +- We have revived efforts to generate Open Graph Protocol images ('social card |
| 59 | + previews') |
| 60 | + [python/docsbuild-scripts#147](https://github.com/python/docsbuild-scripts/issues/147) |
| 61 | +- Sphinx 8.2 (upcoming) will support a `:py:deco:` cross-reference role. Thanks to |
| 62 | + Erlend Aasland and Alex Waygood for discussion |
| 63 | + [sphinx-doc/sphinx#13105](https://github.com/sphinx-doc/sphinx/issues/13105). |
| 64 | +- Translation progress since 14 December 2024: |
| 65 | + - zh-cn: 79.46% -> 80.64% |
| 66 | + - es: 62.38% -> 63.28% |
| 67 | + - pt-br: 53.79% -> 58.24% |
| 68 | + - zh-tw: 36.62% -> 37.00% |
| 69 | + - pl: 8.24% -> 9.44% |
| 70 | + - gr: 4.62% -> 4.83% |
| 71 | + - (please note that as of now completion tracking bases on paragraphs number, not |
| 72 | + [words](https://github.com/izimobil/polib/pull/166) number, and may not express the |
| 73 | + translation effort precisely) |
| 74 | + - [source](https://github.com/m-aciek/pydocs-translation-dashboard/compare/f015a5c401118514c12ae4c75328a201a46171c5...gh-pages) |
| 75 | + |
| 76 | +## Discussion |
| 77 | + |
| 78 | +- The [Python Wiki](https://wiki.python.org/moin/Documentation) has a great deal of |
| 79 | + information, but much of it is badly outdated. For documentation-related pages, |
| 80 | + perhaps we ought remove these and redirect readers to d.p.o? |
| 81 | + - [Hugo] This came up recently. Marc-André was keen on keeping the wiki around. See |
| 82 | + <https://discuss.python.org/t/remove-the-link-to-the-old-python-wiki/45316/13> |
| 83 | + - [Carol] Would love to see the wiki go away completely. First, we should go through |
| 84 | + the d.p.o docs and remove references to the wiki. There's a lot of out-of-date |
| 85 | + stuff, and it's very confusing. |
| 86 | + - [Hugo] There are 22 instances of `wiki.python` in the docs. |
| 87 | + - People might be against deleting stuff. |
| 88 | + - Wikis are useful when they're kept outdated. This one isn't. |
| 89 | + - [Daniele] We have the same problem at work; people don't want to throw it away but |
| 90 | + it's mostly garbage and no one wants to go through it and make it better. |
| 91 | + - [Joe] Would it be useful to add a banner that explicitly says it's unmaintained? |
| 92 | + - [Adam] There are some pages that are actively maintained. We can change it, but it's |
| 93 | + onerous to make edits. Don't know how to get history or get the content. |
| 94 | + - [Carol] I still think I have wiki access. After we get the links out of d.p.o, maybe |
| 95 | + we can go through the wiki, search for CPython and replace the info with links to |
| 96 | + docs. It's a heavy lift to get rid of it. |
| 97 | +- There has been a long discussion on syntax and style for describing Python types in |
| 98 | + documentation, primarily taking place in the comments of a merged PR(!) in the Sphinx |
| 99 | + repository [sphinx-doc/sphinx#13242](https://github.com/sphinx-doc/sphinx/pull/13242). |
| 100 | + Do we wish to take a view here? |
| 101 | + - [Adam] In our docs, we can mark up types as static annotations in Python, or |
| 102 | + describe them in prose. Which do we want to standardize on? This was already |
| 103 | + discussed; are there any strong opinions we could take to the EB? |
| 104 | + - [Carol] Adam will go to the next EB meeting and hopefully it'll get resolved. |
| 105 | +- Request for comment: how best to present abstract methods and classes? See |
| 106 | + [sphinx-doc/sphinx#13271](https://github.com/sphinx-doc/sphinx/pull/13271). Options: |
| 107 | + - _`abstractmethod`_` write()` |
| 108 | + - _`abstract method`_` write()` |
| 109 | + - _`abstract`_` write()` |
| 110 | + * [Petr] Would it be possible to link that word to the glossary? (yes, we could) |
| 111 | +- Request for comment: how tightly should we draw the distinction between 'async', |
| 112 | + 'awaitable', and 'coroutine' callables? Note that Python's documentation currently |
| 113 | + uses the latter two forms, but Sphinx only (currently) supports the former. |
| 114 | + - [`:async:` option](https://www.sphinx-doc.org/en/master/usage/domains/python.html#directive-option-py-function-async) |
| 115 | + (Sphinx) |
| 116 | + - coro example: |
| 117 | + [`asyncio.sleep`](https://docs.python.org/3/library/asyncio-task.html#asyncio.sleep) |
| 118 | + - awaitable example: |
| 119 | + [`asyncio.gather`](https://docs.python.org/3/library/asyncio-task.html#asyncio.gather) |
| 120 | + * [Petr] the distinction is confusing; ideally they should be made equivalent. But as |
| 121 | + long as they're different, the docs should be precise |
| 122 | + |
| 123 | +### Python Project Documentation |
| 124 | + |
| 125 | +_Relating to `docs.python.org`, `peps.python.org`, `devguide.python.org`, etc._ |
| 126 | + |
| 127 | +- [bswck] Track upstream->downstream translation block update alerts |
| 128 | + |
| 129 | + - Not discussed. |
| 130 | + |
| 131 | +- [Hugo] The availability directives are like: |
| 132 | + `.. availability:: Linux >= 2.6.27 with glibc >= 2.8`. Should we automatically replace |
| 133 | + ">=" with "≥", or rewrite as "version 2.8 or later" per Google, Microsoft and Apple |
| 134 | + style guides? |
| 135 | + [python/cpython#129597 (comment)](https://github.com/python/cpython/pull/129597#discussion_r1939080570) |
| 136 | + |
| 137 | + - [Petr] I'd keep the directives compact; they're not prose |
| 138 | + - [Joe] I'd use the single symbol |
| 139 | + - [Joe] The Unicode symbol was introduced in 1993, hopefully it renders well on near |
| 140 | + anything |
| 141 | + - [Petr] If there's an issue with Unicode in some of the backends, we should fix that |
| 142 | + |
| 143 | +- [Hugo] Links back to homepage: |
| 144 | + [python/python-docs-theme#217](https://github.com/python/python-docs-theme/issues/217) |
| 145 | + |
| 146 | + - [Adam] PEPs have a link to both python.org and peps.python.org. It's probably best |
| 147 | + to have both links. If I'd have to choose, I'd have the icon either unlinked or go |
| 148 | + to `docs.`. |
| 149 | + - [Petr] I'd rather have the link go to docs.python.org. It'd be more useful to folks |
| 150 | + who are visiting for the first time, and then have the docs homepage itself have a |
| 151 | + link to the standard python.org. |
| 152 | + |
| 153 | +- [Maciek] Moving into the inside of the Python GitHub organization |
| 154 | + |
| 155 | + - Python Docs Translation Dashboard repository? |
| 156 | + - Transifex automation repository? |
| 157 | + - or should we add a new organization for the around-translations-efforts? |
| 158 | + - [Petr] I recommend a new organization, where you're an admin and can set it up |
| 159 | + however you want |
| 160 | + - [Repo policy](https://devguide.python.org/developer-workflow/development-cycle/#organization-repository-policy) |
| 161 | + - [Adam] This could live under `python`, the question is if it's a good idea. It might |
| 162 | + make it easier to maintain. |
| 163 | + - [Adam] For the dashboard, eventually we could move it to a folder in the |
| 164 | + docsbuild-scripts repo. |
| 165 | + - [Carol] I like both options, but note that we can always move repos from a |
| 166 | + translations organization to `python` |
| 167 | + - [Hugo] We might want to add the dashboard directly to the devguide. Maybe by having |
| 168 | + it generate a JSON file that devguide consumes? |
| 169 | + - [maciek] An organization is good for discoverability, and for shared maintenance in |
| 170 | + case the original maintainer steps down. |
| 171 | + - [Adam] Could we create a python-translations organization right now? |
| 172 | + ([yes](https://github.com/python-docs-translations)) |
| 173 | + - [Adam] Is the devguide the best place for the dashboard? Maybe we should have the |
| 174 | + dashboard on docs.python.org somewhere |
| 175 | + |
| 176 | +- [Maciek] Is displaying number of Sphinx build warnings in scope of Python Docs |
| 177 | + Translation Dashboard |
| 178 | + [dashboard#45](https://github.com/python-docs-translations/dashboard/pull/45) |
| 179 | + - [Hugo] Would it be useful to you as a translator? (yes) |
| 180 | + - [Adam] We don't use nitpicky mode currently. Instinctively, going to the level of |
| 181 | + sphinx warnings is a bit much. |
| 182 | + - [Maciek] It could be a motivation for potential contributors. |
| 183 | + |
| 184 | +## Next meeting |
| 185 | + |
| 186 | +The docs team generally meets on the first Tuesday of every month around 20:00-ish UTC. |
| 187 | + |
| 188 | +We have a recurring Google Calendar event for the meeting. Let Mariatta know your email |
| 189 | +address and she can invite you. |
0 commit comments