improve doc build and readme (#4)

.github/workflows/sphinx.yml

@@ -1,7 +1,6 @@
 on:
   pull_request:
-  push:
-    branches: [main]
+  release:
 
 jobs:
   doc:
@@ -11,10 +10,8 @@ jobs:
     - uses: actions/setup-python@v2
       with:
         python-version: "3.9"
-    - run: |
-        python -m pip install -e .[doc]
-        cd doc
-        sphinx-build -b html -d _build/doctrees . _build/html
+    - run: python -m pip install -e .[doc]
+    - run: python doc/build.py
     - uses: peaceiris/actions-gh-pages@v3
       if: github.ref == 'refs/heads/main'
       with:

README.rst

@@ -1,6 +1,8 @@
 Jacobi
 ======
 
+`Documentation <https://hdembinski.github.io/jacobi/>`_
+
 Fast numerical derivatives for real analytic functions with arbitrary round-off error.
 
 Features

doc/build.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python3
+import subprocess as subp
+from pathlib import Path
+import sys
+
+cmd = "sphinx-build -W -b html -d _build/doctrees . _build/html"
+
+sys.exit(subp.call(cmd.split(), cwd=Path(__file__).parent))

doc/conf.py

@@ -12,15 +12,17 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-# import sys
-# import os
 from pathlib import Path
 
 with open("index.rst.in") as f:
     stub = f.read()
 
 with open(Path("..") / "README.rst") as f:
     readme = f.read().replace("doc/", "")
+    # remove line 4
+    lines = readme.split("\n")
+    lines = lines[:3] + lines[4:]
+    readme = "\n".join(lines)
 
 with open("index.rst", "w") as f:
     f.write(stub + "\n" + readme)