From dcc24a2eeabf010a59c84090a9c98a06665e7260 Mon Sep 17 00:00:00 2001 From: Michael O'Brien Date: Sat, 23 Mar 2024 17:16:37 -0400 Subject: [PATCH] fix build docs workflow --- .github/workflows/build_docs.yml | 11 ++--------- README.md | 2 +- mkdocs.yml | 3 +-- 3 files changed, 4 insertions(+), 12 deletions(-) diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index 5c7b3720..668762e8 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -26,12 +26,5 @@ jobs: python -m pip install --upgrade pip python -m pip install .[docs] - - name: Build docs - run: | - mkdocs build - - - name: Upload docs - uses: actions/upload-artifact@v2 - with: - name: docs - path: site \ No newline at end of file + - name: generate and deploy documentation + run: mkdocs gh-deploy -d https://mjo22.github.io/cryojax diff --git a/README.md b/README.md index 7bfc6bc5..8be4d857 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

cryoJAX

![Tests](https://github.com/mjo22/cryojax/actions/workflows/testing.yml/badge.svg) -![Lint](https://github.com/mjo22/cryojax/actions/workflows/black.yml/badge.svg) +![Lint](https://github.com/mjo22/cryojax/actions/workflows/ruff.yml/badge.svg) cryoJAX is a library that provides tools for simulating and analyzing cryo-electron microscopy (cryo-EM) images. It is built on [`jax`](https://jax.readthedocs.io/en/latest/). diff --git a/mkdocs.yml b/mkdocs.yml index a14f7f03..c19a8487 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,7 +9,6 @@ theme: site_name: cryoJAX site_description: The documentation for cryoJAX. site_author: Michael O'Brien -site_url: https://mjo22.github.io/cryojax/ repo_url: https://github.com/mjo22/cryojax repo_name: mjo22/cryojax @@ -52,7 +51,7 @@ plugins: show_source: false members_order: source heading_level: 4 - + nav: - 'index.md' - Examples: