Skip to content

Commit fd3fac9

Browse files
maxencefaldormaxencefaldor
committed
Add mkdocs
1 parent a6ed585 commit fd3fac9

29 files changed

Lines changed: 2284 additions & 1282 deletions

‎.github/workflows/docs.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: docs
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
concurrency:
13+
group: "pages"
14+
cancel-in-progress: false
15+
16+
jobs:
17+
build:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- uses: actions/setup-python@v5
22+
with:
23+
python-version: '3.13'
24+
- run: pip install -e .[docs]
25+
- run: mkdocs build --clean
26+
- uses: actions/upload-pages-artifact@v3
27+
with:
28+
path: ./site
29+
30+
deploy:
31+
needs: build
32+
runs-on: ubuntu-latest
33+
environment:
34+
name: github-pages
35+
url: ${{ steps.deployment.outputs.page_url }}
36+
steps:
37+
- id: deployment
38+
uses: actions/deploy-pages@v4

‎.github/workflows/ruff.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Ruff
1+
name: ruff
22

33
on:
44
push:

‎.github/workflows/tests.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Tests
1+
name: tests
22

33
on:
44
push:

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@ wheels/
2323
output/
2424
examples/1D-ARC/
2525
examples/data/
26+
site/

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# CAX: Cellular Automata Accelerated in JAX
22

33
<div align="center">
4-
<img src="docs/cax.png" alt="logo" width="512"></img>
4+
<img src="https://raw.githubusercontent.com/maxencefaldor/cax/main/docs/assets/cax.png" alt="logo" width="512"></img>
55
</div>
66

77
[![Pyversions](https://img.shields.io/pypi/pyversions/cax.svg?style=flat)](https://pypi.python.org/pypi/cax)

docs/architecture.png renamed to assets/architecture.png

File renamed without changes.

docs/ca_types.png renamed to assets/ca_types.png

File renamed without changes.

docs/cax.png renamed to assets/cax.png

File renamed without changes.

docs/cax.svg renamed to assets/cax.svg

File renamed without changes.

docs/self_autoencoding_mnist.png renamed to assets/self_autoencoding_mnist.png

File renamed without changes.

0 commit comments

Comments
 (0)