Remove out-of-date make things, new top-level Makefile

Author: honno

.circleci/config.yml

@@ -20,9 +20,9 @@ jobs:
           no_output_timeout: 25m
           command: |
             pip install .[doc]
-            make -C spec/ build
+            make
       - store_artifacts:
-          path: spec/_build/
+          path: _site/
 
 workflows:
   version: 2

.github/workflows/pages.yml

@@ -83,7 +83,7 @@ jobs:
         run: |
           # Turn warnings into errors and ensure .doctrees is not deployed:
           export SPHINXOPTS="-b html -WT --keep-going -d doctrees"
-          make -C spec/ build
+          make
 
       # Configure Git:
       - name: 'Configure Git'
@@ -101,8 +101,8 @@ jobs:
 
       - name: 'Copy build to root'
         run: |
-          cp -R ./spec/_build/* .
-          cp ./spec/_build/.gitignore .
+          cp -R ./_site/* .
+          cp ./_site/.gitignore .
         timeout-minutes: 10
 
       # Commit changes to:

.github/workflows/preview.yml

@@ -11,6 +11,6 @@ jobs:
         uses: larsoner/circleci-artifacts-redirector-action@master
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-          artifact-path: 0/spec/_build/draft/index.html
+          artifact-path: 0/_site/draft/index.html
           circleci-jobs: build_page
           job-title: Check the rendered docs here!

.gitignore

@@ -22,7 +22,7 @@
 # SOFTWARE.
 #/
 
-spec/_build/
+_site/
 doctrees/
 build/
 .vscode/

CONTRIBUTING.md

@@ -33,9 +33,8 @@ folder in `spec/`. To build the whole website, which includes every version of
 the spec, you can utilize the `make` commands defined in `spec/Makefile`:
 
 ```sh
-$ make -C spec/ clean
-$ make -C spec/ build
-$ ls spec/_build/
+$ make
+$ ls _site/
 2021.12/  draft/  index.html  latest/  versions.json
 ```
 

Makefile

@@ -0,0 +1,23 @@
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?= -W --keep-going
+SOURCEDIR     = ./spec
+BUILDDIR      = _site
+
+.PHONY: all clean build
+
+all: clean build
+
+clean:
+	-rm -rf $(BUILDDIR)
+	-rm -rf $(SOURCEDIR)/**/generated
+
+build:
+	-mkdir -p $(BUILDDIR)
+	-cp "$(SOURCEDIR)/_gitignore.txt" "$(BUILDDIR)/.gitignore"
+	-cp "$(SOURCEDIR)/versions.json" "$(BUILDDIR)/versions.json"
+	-cp "$(SOURCEDIR)/index.html" "$(BUILDDIR)/index.html"
+	-touch "$(BUILDDIR)/.nojekyll"
+	-sphinx-build "$(SOURCEDIR)/2021.12" "$(BUILDDIR)/2021.12" $(SPHINXOPTS)
+	-cp -r "$(BUILDDIR)/2021.12" "$(BUILDDIR)/latest"
+	-sphinx-build "$(SOURCEDIR)/draft" "$(BUILDDIR)/draft" $(SPHINXOPTS)

spec/Makefile

@@ -22,7 +22,7 @@
 # SOFTWARE.
 #/
 
-spec/_build/
+_site
 build/
 doctrees/
 .vscode/