convert docs to markdown; add github action (#31)

* convert docs to markdown; add github action
* drop python 2.7, adjust pypy version
* adjust pyproject build backend settings

Author: dholth

.github/workflows/sphinx.yml

@@ -0,0 +1,48 @@
+name: Sphinx
+on:
+  - push
+  - pull_request
+
+jobs:
+  sphinx:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+          architecture: "x64"
+          cache: "pip"
+      - name: Build Documentation
+        run: |
+          pip install .[docs]
+          cd docs
+          make html
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          # Upload entire repository
+          path: 'build/html'
+
+  pages:
+
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+    needs: [sphinx]
+
+    # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.github/workflows/upload-pypi-source.yml

@@ -7,12 +7,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [2.7, 3.7, 3.8, 3.9, pypy2, pypy3]
+        python-version: ["3.8", "3.9", "3.10", pypy3.9]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     # You can test your matrix by printing the current Python version
@@ -24,7 +24,7 @@ jobs:
         scons -c
         scons
         python -m pip install dist/enscons*.whl
-      
+
     # - name: Upload artifacts
     #   uses: actions/upload-artifact@v1
     #   with:

docs/Makefile

@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = ../build
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4

docs/conf.py

@@ -31,6 +31,7 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'myst_parser',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/index.md

@@ -0,0 +1,18 @@
+% enscons documentation master file, created by
+% sphinx-quickstart on Fri Jul  1 19:56:09 2016.
+% You can adapt this file completely to your liking, but it should at least
+% contain the root `toctree` directive.
+
+```{eval-rst}
+.. include:: ../README.rst
+```
+
+```{toctree}
+:maxdepth: 2
+```
+
+# Indices and tables
+
+- {ref}`genindex`
+- {ref}`modindex`
+- {ref}`search`

docs/index.rst

@@ -0,0 +1,5 @@
+# docs
+furo
+sphinx
+myst-parser
+mdit-py-plugins>=0.3.0

docs/requirements.txt

@@ -3,9 +3,7 @@ name = "enscons"
 description = "Tools for building Python packages with SCons"
 version = "0.28.0"
 
-authors = [
-    {name = "Daniel Holth", email = "[email protected]"}
-]
+authors = [{ name = "Daniel Holth", email = "[email protected]" }]
 classifiers = [
   "Programming Language :: Python :: 2.7",
   "Programming Language :: Python :: 3",
@@ -28,11 +26,16 @@ url = "https://github.com/dholth/enscons"
 
 [project.optional-dependencies]
 cli = ["click"]
-doc = ["sphinx"]
+docs = ["furo", "sphinx", "myst-parser", "mdit-py-plugins>=0.3.0"]
 
 [project.scripts]
 setup2toml = "enscons.setup2toml:main"
 
 [build-system]
 build-backend = "enscons.api"
-requires = ["pytoml>=0.1"] # enscons users add "enscons>=0.28" to this list
+backend-path = ["."] # only for bootstrapped enscons
+requires = [
+  "scons",
+  "packaging",
+  "pytoml>=0.1",
+] # enscons users add "enscons>=0.28" to this list