diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml index 25b43b95..da5ba48b 100644 --- a/.github/workflows/build-docs.yaml +++ b/.github/workflows/build-docs.yaml @@ -2,6 +2,7 @@ name: Build MkDocs on: push: pull_request: + workflow_dispatch: jobs: build: @@ -10,6 +11,11 @@ jobs: - name: Checkout repository uses: actions/checkout@v1 + - name: Copy example-notebooks repository + run: | + git clone https://github.com/dandi/example-notebooks + mv ./example-notebooks ./docs/ + - name: Install version of Python uses: actions/setup-python@v5 with: diff --git a/.github/workflows/publishdocs.yaml b/.github/workflows/publishdocs.yaml index b2767349..2778e03a 100644 --- a/.github/workflows/publishdocs.yaml +++ b/.github/workflows/publishdocs.yaml @@ -3,6 +3,7 @@ on: push: branches: - master + workflow_dispatch: jobs: build: @@ -12,6 +13,11 @@ jobs: - name: Checkout master uses: actions/checkout@v1 + - name: Copy example-notebooks repository + run: | + git clone https://github.com/dandi/example-notebooks + mv ./example-notebooks ./docs/ + - name: Deploy docs uses: mhausenblas/mkdocs-deploy-gh-pages@master env: diff --git a/mkdocs.yml b/mkdocs.yml index 180fb29e..4186983f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,6 +39,13 @@ nav: - REST API Swagger: https://api.dandiarchive.org/swagger - REST API Redoc: https://api.dandiarchive.org/redoc - DANDI Hub: "50_hub.md" + - Tutorials: + - DANDI User Guide, Part I: "example-notebooks/dandi/DANDI User Guide, Part I.ipynb" + - DANDI User Guide, Part II: "example-notebooks/dandi/DANDI User Guide, Part II.ipynb" + - Simple Dandiset Search: "example-notebooks/tutorials/neurodatarehack_2024/simple_dandiset_search.ipynb" + - Advanced Asset Search: "example-notebooks/tutorials/cosyne_2023/advanced_asset_search.ipynb" + - Streaming and interacting with NWB data: "example-notebooks/tutorials/bcm_2024/analysis-demo.ipynb" + - NWB Widget Demo: "example-notebooks/demos/NWBWidget-demo.ipynb" - Health Status: - Dandisets: https://github.com/dandi/dandisets-healthstatus - Services: https://www.dandiarchive.org/upptime @@ -60,6 +67,9 @@ markdown_extensions: plugins: - search - open-in-new-tab + - mkdocs-jupyter: + ignore_h1_titles: True + include: ["*.ipynb"] # Customize theme extra: diff --git a/requirements.txt b/requirements.txt index 1952f709..148a6dbf 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ mkdocs-material>=9.5.10 pymdown-extensions mkdocs-open-in-new-tab +mkdocs-jupyter \ No newline at end of file