Merge branch 'dev' into pr/263

Author: paul-buerkner

.github/workflows/multiversion-docs.yaml

@@ -3,9 +3,6 @@
 name: multiversion-docs
 
 on:
-  pull_request:
-    branches:
-      - dev
   workflow_dispatch:
   push:
     branches:
@@ -48,7 +45,7 @@ jobs:
         run: |
           cd ./dev/docsrc
           make clean
-          make github
+          make docs-sequential
       - name: Commit changes to docs
         run: |
           cd ./gh-pages-dev

.github/workflows/test-docs.yaml

@@ -0,0 +1,37 @@
+
+name: test-docs
+
+on:
+  pull_request:
+    branches:
+      - dev
+
+jobs:
+  build_docs:
+    runs-on: ubuntu-latest
+    env:
+      KERAS_BACKEND: "jax"
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+          cache: "pip"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install .[docs]
+          python -m pip install jax
+      - name: Make docs from local state
+        run: |
+          cd ./docsrc
+          make clean
+          make local
+      - name: Clean up
+        run: |
+          cd ./docsrc
+          make clean-all

.gitignore

@@ -6,10 +6,11 @@ projects/
 */bayesflow.egg-info
 docsrc/_build/
 docsrc/_build_polyversion
-docsrc/.bf_doc_gen_venv
+docsrc/.docs_venvs
 docsrc/source/api
 docsrc/source/_examples
 docsrc/source/contributing.md
+examples/checkpoints/
 build
 docs/
 

.pre-commit-config.yaml

@@ -14,7 +14,7 @@
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.9.6
+  rev: v0.9.10
   hooks:
     # Run the linter.
     - id: ruff

CONTRIBUTING.md

@@ -145,23 +145,37 @@ pip install .[docs]
 ```
 
 The overall *structure* of the documentation is manually designed, but the API documentation is auto-generated.
+New top-level modules (i.e., `bayesflow.mynewmodule`) have to be manually added to the list in `docsrc/source/api/bayesflow.rst` to be included.
 
-You can re-build the current documentation with
+You can re-build the for your local state with:
 
 ```bash
 cd docsrc
-make clean && make dev
+make clean && make local
 # in case of issues, try `make clean-all`
 ```
 
+Note that files ignored by git (i.e., listed in `.gitignore`) are not included in the documentation.
+
 We also provide a multi-version documentation. To generate it, run
 
 ```bash
 cd docsrc
-make clean && make github
+make clean && make docs
 ```
 
+This will create and cache virtual environments for the build at `docsrc/.docs_venvs`.
+To remove them, run `make clean-all` in the `docsrc` directory.
+
 The entry point of the rendered documentation will be at `docs/index.html`.
+To view the docs in the browser (which ensures correct redirects), run:
+
+```bash
+cd docsrc
+make view-docs
+```
+
+See `docsrc/README.md` for more details.
 
 Note that undocumented changes will likely be rejected.
 

assets/__init__.py

@@ -5,6 +5,7 @@
     datasets,
     diagnostics,
     distributions,
+    experimental,
     networks,
     simulators,
     workflows,