Skip to content

Commit 786d4df

Browse files
committed
convert to mkdocs
1 parent 6738646 commit 786d4df

31 files changed

+315
-639
lines changed

.github/workflows/docs.yml

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,29 @@
11
name: docs
2-
32
on:
43
push:
54
branches:
65
- main
7-
tags:
8-
- "v*"
9-
pull_request:
10-
branches:
11-
- main
12-
6+
permissions:
7+
contents: write
138
jobs:
14-
docs:
9+
deploy:
1510
runs-on: ubuntu-latest
1611
steps:
17-
- uses: compas-dev/compas-actions.docs@v4
12+
- uses: actions/checkout@v4
13+
- name: Configure Git Credentials
14+
run: |
15+
git config user.name github-actions[bot]
16+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
17+
- uses: actions/setup-python@v5
18+
with:
19+
python-version: 3.x
20+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
21+
- uses: actions/cache@v4
1822
with:
19-
github_token: ${{ secrets.GITHUB_TOKEN }}
20-
doc_url: https://compas.dev/compas_notebook/
23+
key: mkdocs-material-${{ env.cache_id }}
24+
path: ~/.cache
25+
restore-keys: |
26+
mkdocs-material-
27+
- run: pip install .[dev,docs]
28+
- run: pip install mkdocs-material
29+
- run: mkdocs gh-deploy --force

docs/_images/compas_notebook.png

-777 KB
Binary file not shown.

docs/api.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/api/compas_notebook.conversions.rst

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/api/compas_notebook.rst

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/api/compas_notebook.scene.rst

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/api/compas_notebook.viewer.rst

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
--8<-- "CHANGELOG.md"

docs/conf.py

Lines changed: 0 additions & 159 deletions
This file was deleted.

docs/examples.rst

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)