Modern CI and Python Tooling

.github/workflows/github_pages.yaml

@@ -0,0 +1,50 @@
+name: GitHub Pages
+on:
+  push:
+    # Release tags are v*, e.g., v0.8.0 or v1.0.0
+    tags:
+      - v*
+jobs:
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.x
+      - name: Install Tox
+        run: pip install tox
+      - name: Build and Deploy Website
+        run: |
+          set -exo
+
+          # Gather current version number for comit message later.
+          version="$(python -c 'import sys; sys.path.insert(0, "."); from sphinx_bootstrap_theme import __version__; print(__version__)')"
+
+          # Be explicit about --workdir so we know exactly where it is.
+          tox --workdir ./.tox -e docs
+          mv .tox/docs/tmp/html/ ..
+          tox -e clean  # remove e.g., __pycache__ and friends
+          rm -rf .tox
+          git reset --hard  # not necessary but not a problem either
+
+          # Get the gh-pages branch with all the previous versions.
+          git remote -v
+          git fetch origin gh-pages
+          git checkout gh-pages
+
+          # Delete everything and then re-add it.
+          git rm -r .
+          mv ../html/* .
+          touch .nojekyll
+          git add -Af .
+          git --no-pager status
+          git --no-pager diff --color=always
+
+          # Configure and push.
+          git config --local user.name github-actions
+          git config --local user.email "[email protected]"
+          git commit -m "Version $version"
+          git push https://${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git

.github/workflows/package.yaml

@@ -0,0 +1,26 @@
+name: Package
+on:
+  push:
+    # Release tags are v*, e.g., v0.8.0 or v1.0.0
+    tags:
+      - v*
+jobs:
+  dist:
+    name: Distribution
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.x
+      - name: Install Tox
+        run: pip install tox
+      - name: Package
+        run: tox -e dist
+      - name: Upload to PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          user: __token__
+          password: ${{ secrets.pypi_password }}

.github/workflows/tests.yaml

@@ -0,0 +1,88 @@
+name: Tests
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.x
+      - name: Install Tox
+        run: pip install tox
+      - name: Lint
+        run: tox -e lint
+  docs:
+    name: Docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.x
+      - name: Install Tox
+        run: pip install tox
+      - name: Build Docs
+        run: tox -e docs
+  dist:
+    name: Dist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.x
+      - name: Install Tox
+        run: pip install tox
+      - name: Build Dist
+        run: tox -e dist
+  linkcheck:
+    name: Linkcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.x
+      - name: Install Tox
+        run: pip install tox
+      - name: Build Linkcheck
+        run: tox -e linkcheck
+  test:
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
+        python-version: [2.7, 3.5, 3.6, 3.7, 3.8]
+    name: Py ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Tox
+        run: pip install tox
+      - name: Test Sphinx 1.8.5
+        env:
+          SPHINX_VERSION: ==1.8.5
+        run: tox -e py
+      - name: Test Sphinx 2.0
+        env:
+          SPHINX_VERSION: ==2.0
+        run: tox -e py
+        if: matrix.python-version >= 3.5
+      - name: Test Sphinx Latest
+        run: tox -e py
+        if: matrix.python-version >= 3.5

.gitignore

@@ -10,3 +10,138 @@ __pycache__
 .vscode
 Pipfile*
 
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+