Add sphinx support - pydotorg compat (ref #1385)

.github/workflows/deploy-gh-pages.yaml

@@ -0,0 +1,42 @@
+name: Deploy to GitHub Pages
+on: [push]
+jobs:
+  deploy-to-pages:
+    runs-on: ubuntu-latest
+    steps:
+      # If you're using actions/checkout@v2 you must set persist-credentials to false in most cases for the deployment to work correctly.
+      - name: Checkout 🛎️
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+
+      - name: Set up Python (3.7) 🐍
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+
+      - name: Cache pip 🧳
+        uses: actions/cache@v2
+        with:
+          # This path is specific to Ubuntu
+          path: ~/.cache/pip
+          # Look to see if there is a cache hit for the corresponding requirements file
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+            ${{ runner.os }}-
+
+      # Install dependencies and build PEPs using sphinx
+      - name: Install and Build 🔧
+        run: |
+          set -x
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          make pages
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: build # The folder the action should deploy.

.gitignore

@@ -9,4 +9,6 @@ __pycache__
 *env
 .vscode
 *.swp
-/build
+build
+package
+venv

.travis.yml

@@ -1,20 +1,61 @@
 language: python
-python:
-  - 3.7
-  - 3.7-dev
+os: linux
 dist: xenial
 
 cache: pip
 
-before_install:
-    - pip install docutils
-script:
-    - make -j$(nproc)
-
-deploy:
-    provider: script
-    script: bash deploy.bash
-    skip_cleanup: true
-    on:
-        branch: master
-        repo: python/peps
+install:
+  - pip install -r requirements.txt
+
+jobs:
+  fast_finish: true
+
+  include:
+    # Main run, tests build, RSS, and packaging
+    - name: "3.7 Makefile Build"
+      python: 3.7
+      env: COMMAND="make sphinx -j$(nproc)"
+      deploy:
+        provider: script
+        script: bash deploy.bash
+        skip_cleanup: true
+        on:
+          branch: master
+          repo: python/peps
+
+    # Tests build on 3.7-dev
+    - name: "3.7-dev Build Test"
+      python: 3.7-dev
+      env: COMMAND="make sphinx -j$(nproc)"
+
+    # Tests build on 3.8
+    - name: "3.8 Build Test"
+      python: 3.8
+      env: COMMAND="make sphinx -j$(nproc)"
+
+    # Tests build on 3.8-dev
+    - name: "3.8-dev Build Test"
+      python: 3.8-dev
+      env: COMMAND="make sphinx -j$(nproc)"
+
+    # Tests build with Fail on Warning
+    - name: "3.8 Fail on Warning"
+      python: 3.8
+      env:
+        - COMMAND="make fail_on_warning -j$(nproc)"
+
+# linkcheck takes far too long (upwards of an hour)
+#    # Checks link references within PEPs
+#    - name: "3.8 Check Links"
+#      python: 3.8
+#      env:
+#        - COMMAND="make check_links -j$(nproc)"
+
+  allow_failures:
+    # Note test failure, but pass the build as a whole
+    - name: "3.8 Fail on Warning"
+
+#    # Check links can fail as it is dependent on external pages
+#    - name: "3.8 Check Links"
+
+script: $COMMAND

AUTHORS.csv

@@ -0,0 +1,12 @@
+Full Name, Surname First, Name Reference
+Ernest W. Durbin III, "Durbin, Ernest W., III", Durbin
+Inada Naoki, "Inada, Naoki", Inada
+Guido van Rossum, "van Rossum, Guido (GvR)", GvR
+Just van Rossum, "van Rossum, Just (JvR)", JvR
+The Python core team and community, The Python core team and community, python-dev
+P.J. Eby, "Eby, Phillip J.", Eby
+Greg Ewing,  "Ewing, Gregory", Ewing
+Jim Jewett, "Jewett, Jim J.", Jewett
+Nathaniel Smith, "Smith, Nathaniel J.", Smith
+Martin v. Löwis, "von Löwis, Martin", von Löwis
+

Makefile

@@ -1,53 +1,42 @@
-# Rules to only make the required HTML versions, not all of them,
-# without the user having to keep track of which.
-#
-# Not really important, but convenient.
+# Builds PEP files to HTML using sphinx
+# Also contains testing targets
 
-PEP2HTML=pep2html.py
+all: sphinx
 
 PYTHON=python3
 
-.SUFFIXES: .txt .html .rst
+pages: rss
+	$(PYTHON) build.py --index-file
 
-.txt.html:
-	@$(PYTHON) $(PEP2HTML) $<
+sphinx:
+	$(PYTHON) build.py
 
-.rst.html:
-	@$(PYTHON) $(PEP2HTML) $<
+fail_on_warning:
+	$(PYTHON) build.py -f
 
-TARGETS= $(patsubst %.rst,%.html,$(wildcard pep-????.rst)) $(patsubst %.txt,%.html,$(wildcard pep-????.txt)) pep-0000.html
-
-all: pep-0000.rst $(TARGETS)
-
-$(TARGETS): pep2html.py
-
-pep-0000.rst: $(wildcard pep-????.txt) $(wildcard pep-????.rst) $(wildcard pep0/*.py) genpepindex.py
-	$(PYTHON) genpepindex.py .
+check_links:
+	$(PYTHON) build.py -c
 
 rss:
 	$(PYTHON) pep2rss.py .
 
-install:
-	echo "Installing is not necessary anymore. It will be done in post-commit."
-
 clean:
-	-rm pep-0000.rst
-	-rm pep-0000.txt
-	-rm *.html
-	-rm -rf build
+	rm pep-0000.rst
+	rm *.html
+	rm -rf build
 
 update:
 	git pull https://github.com/python/peps.git
 
 venv:
 	$(PYTHON) -m venv venv
-	./venv/bin/python -m pip install -U docutils
+	./venv/bin/python -m pip install -r requirements.txt
 
 package: all rss
-	mkdir -p build/peps
+	mkdir -p package/peps
+	$(PYTHON) package.py
 	cp pep-*.txt build/peps/
 	cp pep-*.rst build/peps/
-	cp *.html build/peps/
 	cp *.png build/peps/
-	cp *.rss build/peps/
-	tar -C build -czf build/peps.tar.gz peps
+	cp *.rss package/peps
+	tar -C package -czf package/peps.tar.gz peps