Commit Graph

15 Commits

Author SHA1 Message Date
Hugo van Kemenade 3e6630877d
Infra: Add directives to show warning banner for deprecated PEPs (#3682)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2024-04-14 07:35:25 -06:00
Hugo van Kemenade f7f9f2d68a
PEP 612: Mark as Final (#3575)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-12 00:20:09 -07:00
Jacob Coffee ff0702ebfc
Infra: update canonical banners to not stick on small screens (#3559)
Updates small media sizes to not have a sticky banner
Adds a helper close button to optionally close banner

Closes #3536
2023-12-02 22:31:13 -08:00
Adam Turner 2d4c98dca7
Infra: Prepare for moving PEPs to a subfolder (#3417) 2023-09-03 04:55:19 +01:00
Hugo van Kemenade 191de06f27
Infra: Revert "Fix a URL in the PyPA specification banner (#3199)" (#3218) 2023-07-31 22:28:06 +01:00
wim glenn 08124264e6
Fix a URL in the PyPA specification banner (#3199) 2023-07-13 03:56:26 +01:00
Pradyun Gedam 06e5a8a693
Implement support for sticky banners and utilize them (#2992) 2023-03-20 08:42:01 +00:00
Hugo van Kemenade 6fc3a4ddf3
Infra: Use relative links to ease development (#2972) 2023-01-22 12:56:05 +02:00
C.A.M. Gerlach bf3465d3e3
Packaging PEPs: Update headers & link canonical PyPA specs (#2690)
* Update headers/etc. of older packaging PEPs to reflect replacement PEPs

* Infra: Fix lowercase and tweak plural in text for PyPA spec banner

* Add banner to all relevant PEPs pointing to their canonical PyPA specs

Co-authored-by: Brett Cannon <brett@python.org>
2022-10-07 08:29:13 -07:00
CAM Gerlach f87de8284c
Infra: Add new directives to point to PEP's canonical content (#2702)
As originally discussed in #2692 , this adds a three new custom directives intended to be used at the top of PEPs:

* `pep-banner`, a generic admonition banner that can be subclassed with an arbitrary message,
* `canonical-docs`, which renders a banner linking to a `Final` PEP's canonical documentation/specification.
* `canonical-pypa-spec`, a banner for packaging interoperability PEPs linking to the canonical PyPA specs.

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-08-02 22:48:56 -05:00
Adam Turner b76fe4351e
Use PEP titles and sections as title text for `:pep:` references (#2366) 2022-02-27 22:58:15 +00:00
Adam Turner 3d60b84e35
PEP 676: Implementation updates (#2208) 2022-01-09 10:07:03 -08:00
Adam Turner 0d93abf9bf
Sphinx support: theming (#1933)
See #2, #1385 for context. Superseeds #1568.

This is the Sphinx-theming part, building on PR #1930.

### Stylesheets:
- `style.css` - styles
- `mq.css` - media queries

### Jinja2 Templates:
- `page.html` - overarching template

### Javascript:
- `doctools.js` - fixes footnote brackets

### Theme miscellany
- `theme.conf` - sets pygments styles, theme internals
2021-06-30 20:19:44 +01:00
Adam Turner 749c2d9a37
Sphinx support: add PEP 0 generation extension (1932)
* Add PEP 0 parser

* Add PEP 0 writer

* Add PEP 0 generator and authors override

* Add/update build and run

* Simplify `create_index_file`

* Special status handling

* Add constants for PEP related magic strings

* Prefer checking on class

* Add PEP.hide_status, use constants

* Remove comment from 2008 (current method works fine)

* Clarify intent of for-else loop

* Hook in to Sphinx (oops, missed when splitting out this PR)

* Rename AUTHORS.csv for clarity

* Sort and strip spaces

* Prefer `authors_overrides` name

* Add pep_0_errors.py

* Move author_sort_by to writer

* PEP init misc

* Split out Author

* Drop pep_0 prefix

* Pass title length as an argument

* Add constants.py to hold global type / status values

* Capitalise constants

* Capitalise constants

* Update PEP classification algorithm

* Extract static methods to module level

* Add emit_text, emit_pep_row

* Use constants in writer.py

* Sort imports

* Sort constants

* Fix sorting in historical and dead PEPs

* Extract static methods to module level

* Extract static methods to module level (parser.py

* Make Author a NamedTuple

* Fix author duplication bug with NamedTuples

* Revert to old PEP classification algorithm

* Define PEP equality
2021-06-12 18:51:14 +01:00
Adam Turner 0f3bbd9ad9
Sphinx support: add docutils support files (#1931)
See #2, #1385 for context. Superseeds #1566.

This is the docutils parsing, transforms and writing part, building on PR #1930. It contains a pseudo-package, `sphinx_pep_extensions`, which itself contains:

### Docutils parsing:
- `PEPParser` - collates transforms and interfaces with Sphinx core
- `PEPRole` - deals with :PEP:`blah` in RST source

### Docutils transforms:
- `PEPContents` (Creates table of contents without page title)
- `PEPFooter` (Dels with footnotes, link to source, last modified commit)
- `PEPHeaders` (Parses RFC2822 headers)
- `PEPTitle` - Creates document title from PEP headers
- `PEPZero` - Masks email addresses and creates links to PEP numbers from tables in `pep-0000.rst`

### Docutils HTML output:
- `PEPTranslator` - Overrides to the default HTML translator to enable better matching of the current PEP styles
2021-06-09 01:37:55 +01:00