Skip to content

Add sphinx support - docutils (ref #1385) #1566

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

Jump to bottom
Closed
wants to merge 108 commits into from
Closed

Add sphinx support - docutils (ref #1385) #1566

wants to merge 108 commits into from

Conversation

AA-Turner
Copy link
Member

See #2, #1385 for context.

This is the docutils parsing, transforms and writing part, comprising

  • core,
  • PEP HTML Translator (Docutils doctree to HTML)
  • PEP Parser (class to provide transforms to Sphinx)
  • PEP Role (deals with :PEP:`XX` in RST source)
  • PEP Contents (Creates table of contents without page title)
  • PEP Footer (Dels with footnotes, link to source, last modified commit)
  • PEP Headers (Parses RFC2822 headers)
  • PEP Title (Creates PEP Title from headers)
  • PEP Zero (Masks email addresses and linkifys PEP numbers)

Note: this is unlikely to successfully build, I am splitting into logical chunks as per Victor's comment.

AA-Turner added 30 commits August 14, 2020 20:59
@AA-Turner
Current state
f4ced1b 
- RFC2822 headers work
- Contents page generated
- Title autogeneration not working
- PEP 0 not started
@AA-Turner
Fix title generation
f83e08f 
Also add pep_parser as I missed it
@AA-Turner
Fix contents section location
9cd91e4
@AA-Turner
Clarify contents page
4a36065
@AA-Turner
Split pep_parser to files
62edb6e
@AA-Turner
Update conf
eb795e0
@AA-Turner
clean imports
a13f959
@AA-Turner
get pep 0 generation to work
c7b9cea
@AA-Turner
Update build and Makefile
9403363
@AA-Turner
Misc cleanup
88e20a2
@AA-Turner
Add sphinx dependency
e6869ca
@AA-Turner
update makefile
4080e62
@AA-Turner
fix for read the docs
af0dfc3
@AA-Turner
updates for contents
531e860 
- exclude contents in transforms
- add custom text in contents.rst
@AA-Turner
support pythondotorg build process
c9e1c14
@AA-Turner
fix urls for read the docs
3dd68a1
@AA-Turner
fix import error
ab28391
@AA-Turner
make compatible with read the docs
1d64717 
- RtD still runs sphinx 1.8.5 so we have had to add compatibility
@AA-Turner
update base url
9d57d7f
@AA-Turner
Fix numerical index (pep list was being overwritten)
e88699f
@AA-Turner
Fix name parsing
cfafa99
@AA-Turner
Update name parsing in PEP 0
d5fe06f
@AA-Turner
Include requirements file
0b2c7a4
@AA-Turner
Update ToC to remove title
31fe99c
@AA-Turner
Update Contents class
1fb3112
@AA-Turner
Fixes as per Éric Araujo's comments
cd600b4
@AA-Turner
move Travis CI to use requirements.txt
6bf48d5
@AA-Turner
Update build to include 3.8 and sanity checks
3c31d04
@AA-Turner
Move to author metadata lookup for PEP index
f779673
@AA-Turner
update .travis.yml
cc2eb9e
AA-Turner added 22 commits August 14, 2020 21:01
@AA-Turner
PEPError helper method
d30356d
@AA-Turner
Functionise
d0e57e0
@AA-Turner
Move constants
771d24e
@AA-Turner
Small changes to pep_zero_generator
8e82d03
@AA-Turner
Update excludes
2385ded
@AA-Turner
Conf updates
1822c19
@AA-Turner
Update sphinx version
1e30f64
@AA-Turner
Remove unneeded files
4b79aaf
@AA-Turner
Fix typos
40d706a
@AA-Turner
Use pydotorg mathematics rendering
6147159
@AA-Turner
Edits for style in __init__.py
b661ccc
@AA-Turner
Clarify elements in build flow
270b825
@AA-Turner
Update pep2rss to closer match current output
4f15149
@AA-Turner
Use absolute path
e257372
@AA-Turner
Add venv to gitignore
c263371
@AA-Turner
Match current state of name parsing branch
116f3a7
@AA-Turner
Makefile should be generating rss!
e37b5d2
@AA-Turner
PEP 249 style is different
c44d852
@AA-Turner
Implemented auto-linking with the PEP pattern
ad4c6a1
@AA-Turner
Definition list styling only applies to headers and footnotes
6586784
@AA-Turner
Add last-modified date to footer re python/pythondotorg#1564
ae53f01
@AA-Turner
Add sphinx support - docutils parsers, roles and transforms.
f80e00a 
Contains:
- core,
- PEP HTML Translator
- PEP Parser
- PEP Role
- PEP Contents
- PEP Footer
- PEP Headers
- PEP Title
- PEP Zero
This was referenced Aug 15, 2020
Closed
Closed
pradyunsg
pradyunsg reviewed Aug 16, 2020
View reviewed changes
@AA-Turner AA-Turner mentioned this pull request Apr 20, 2021
Merged
@AA-Turner AA-Turner closed this Apr 20, 2021
pablogsal pushed a commit that referenced this pull request Jun 9, 2021
@AA-Turner
Sphinx support: add docutils support files (#1931)
0f3bbd9 
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
Reviewers

@pradyunsg pradyunsg pradyunsg left review comments

Assignees
No one assigned
Labels
CLA signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@AA-Turner @pradyunsg @the-knights-who-say-ni