Add sphinx support - docutils (ref #1385) #1566
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- RFC2822 headers work - Contents page generated - Title autogeneration not working - PEP 0 not started
Also add pep_parser as I missed it
- exclude contents in transforms - add custom text in contents.rst
- RtD still runs sphinx 1.8.5 so we have had to add compatibility
Contains: - core, - PEP HTML Translator - PEP Parser - PEP Role - PEP Contents - PEP Footer - PEP Headers - PEP Title - PEP Zero
pradyunsg
reviewed
Aug 16, 2020
Co-authored-by: Pradyun Gedam <3275593+pradyunsg@users.noreply.github.com>
Merged
pablogsal
pushed a commit
that referenced
this pull request
Jun 9, 2021
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See #2, #1385 for context.
This is the docutils parsing, transforms and writing part, comprising
Note: this is unlikely to successfully build, I am splitting into logical chunks as per Victor's comment.