add README generation

.github/workflows/update_readme.yml

@@ -0,0 +1,31 @@
+name: Update ReadMe
+
+on:
+  push:
+    branches: [ "main" ]
+
+permissions:
+  contents: write
+
+jobs:
+  create-release:
+    name: update-readme
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '>=3.11'
+      - run: |
+          python -m pip install sphinx
+          python -m pip install .
+          python -m run readme
+          if git diff --exit-code README.rst > /dev/null; then
+            echo "No changes in README"
+          else
+            git config user.name "GitHub Actions"
+            git config user.email "actions@github.com"
+            git add README.rst
+            git commit -m "generate new README"
+            git push
+          fi

docs/conf.py

@@ -56,10 +56,10 @@ def run(self):
 .. |custom| replace:: custom
 .. _custom_cmake: {repo_src + '/cmake/custom.cmake'}
 .. |custom_cmake| replace:: *custom.cmake*
-.. _doc: {docs}
-.. |doc| replace:: **Documentation**
 .. _model_zoo: {repo_main + '/model_zoo/models.py'}
 .. |model_zoo| replace:: *model_zoo*
+.. _doc: {docs}
+.. |doc| replace:: **Documentation**
 .. |name| replace:: *{ai3.__name__}*
 .. |pkg_name| replace:: *{pkg_name}*
 '''