Sphinx - core #1930
Sphinx - core #1930
Conversation
|
|
||
| # New Sphinx targets: | ||
|
|
||
| SPHINX_JOBS=8 |
There was a problem hiding this comment.
Arbitrary number, beyond that diminishing returns. This was tested on GHA CI infrastructure, so a different number may be faster locally.
I'm considering disabiling search capabilities, as people will likely be better served with site:peps.python.org blah searches, and I think that the word stemming process takes a bit of time. Sphinx builds on CI took around 7 minutes, which does seem quite long (3-4x straight docutils)
(From #1934 (comment) - the makefile changes there come from this core PR)
| @@ -0,0 +1,41 @@ | |||
| name: Deploy to GitHub Pages | |||
There was a problem hiding this comment.
@AA-Turner I think we don't deploy on the GitHub pages... What's the reason for this workflow?
There was a problem hiding this comment.
We don't currently. #1385 has extensive discussion on this (#1385 (comment) etc) - the main drive is that deploying to GH pages is easy and free, and enables previewing the changes before any switchovers etc.
requirements.txt
Outdated
| docutils >= 0.16 | ||
|
|
||
| # # For RSS | ||
| # feedgen >= 0.9.0 # For RSS feed |
There was a problem hiding this comment.
Why have you commented on the following lines?
There was a problem hiding this comment.
Half laziness in reserving the spaces for the RSS piece of work - should #1934 be merged the lines would be subsequently uncommented. If easier I could remove from this PR just for clarity?
There was a problem hiding this comment.
Could you remove these lines and add them later in #1934? That way the commit is clear
|
@AA-Turner could you rebase this PR? That way I can approve it to run the CI |
|
Let's try to move this along, @AA-Turner could you please rebase this PR and address my comment? I can merge after that so we can continue with the rest |
|
@pablogsal done & removed the extraneous stuff from |
Ok, I have unblocked the CI |
|
🚀 Ok, @AA-Turner, let's move on to the next one |
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
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
See #2, #1385 for context. Superseeds #1565.
This is the minimal core Sphinx support part, adding a bare minimum of useful things to get Sphinx to build and deploy, whilst not affecting the current build system. There is no theming or custom parsing needed to properly deal with PEPs.
build.py- build scriptconf.py- Sphinx configurationMakefile- new targets for Sphinx.gitignore- add ignores forvenvandpackagedirectoriescontents.rst- Sphinx page to discover all PEPsdeploy-gh-pages.yaml- builds and deploys to github pagesrequirements.txt