Skip to content

Remove :platform: doc #1744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
encukou merged 2 commits into from
Mar 6, 2026
Merged

Remove :platform: doc #1744

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18c1fb5
Remove `:platform:` doc
StanFromIreland Feb 20, 2026
ab007ef
Add `availability` doc
StanFromIreland Feb 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions documentation/markup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,11 +373,10 @@ module being documented. Each module should be documented in its own file.
Normally this markup appears after the title heading of that file; a typical
file might start like this::

:mod:`parrot` -- Dead parrot access
===================================
:mod:`!parrot` -- Dead parrot access
====================================

.. module:: parrot
:platform: Unix, Windows
:synopsis: Analyze and reanimate dead parrots.
.. moduleauthor:: Eric Cleese <eric@python.invalid>
.. moduleauthor:: John Idle <john@python.invalid>
Expand All @@ -391,12 +390,6 @@ As you can see, the module-specific markup consists of two directives, the
or submodule. The name should be fully qualified (that is, including the
package name for submodules).

The ``platform`` option, if present, is a comma-separated list of the
platforms on which the module is available (if it is available on all
platforms, the option should be omitted). The keys are short identifiers;
examples that are in use include "IRIX", "Mac", "Windows", and "Unix". It is
important to use a key which has already been used when applicable.

The ``synopsis`` option should consist of one sentence describing the
module's purpose -- it is currently only used in the Global Module Index.

Expand Down
Loading