docs: WP6 epythet documentation sweep

.github/workflows/ci.yml

@@ -83,10 +83,22 @@ jobs:
       - name: Publish
         run: |
           twine upload dist/$PROJECT_NAME-$VERSION.tar.gz -u ${{ secrets.PYPI_USERNAME }} -p ${{ secrets.PYPI_PASSWORD }} --non-interactive  --skip-existing --disable-progress-bar
-          epythet make . github
 
       - name: Push Changes
         run: pack check-in "**CI** Formatted code + Updated version number and documentation. [skip ci]" --auto-choose-default-action --bypass-docstring-validation --bypass-tests --bypass-code-formatting --verbose
 
       - name: Tag Repository
         run: isee tag-repo $VERSION
+
+  github-pages:
+    name: Publish GitHub Pages
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && github.ref == format('refs/heads/{0}', github.event.repository.default_branch)"
+    needs: publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: i2mint/epythet/actions/publish-github-pages@master
+        with:
+          # IMPORTANT Note: You don't need to specify GITHUB_TOKEN in your repo secrets.
+          # GITHUB_TOKEN is special & automatically provided to your workflow run.
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          ignore: "tests/,scrap/,examples/"

.gitignore

@@ -108,3 +108,6 @@ venv.bak/
 
 # PyCharm
 .idea
+
+# epythet regenerates the Sphinx sources on every build
+docsrc/

README.md

@@ -38,6 +38,16 @@ to bend your interface with data to your will.
 [More examples](#more-examples) will give you a taste of how you can adapt the three main aspects of 
 storage (persistence, serialization, and indexing) to your needs.
 
+<!-- epythet:agentic-readme:start -->
+# For AI agents
+
+`py2store` publishes its documentation in forms made for coding agents. If you are one, start here.
+
+**The documentation, machine-readable**: [`llms.txt`](https://i2mint.github.io/py2store/llms.txt) indexes every page; [`py2store.md`](https://i2mint.github.io/py2store/py2store.md) is the whole documentation in one file; every page has a `.md` twin; [`objects.inv`](https://i2mint.github.io/py2store/objects.inv) maps symbols to URLs.
+
+If you like writing your own code, the rest of this README is written for you, starting at [Contents](#contents).
+<!-- epythet:agentic-readme:end -->
+
 # Contents
 
 - [py2store](#py2store)