Skip to content

Commit

Permalink
fix build docs workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
mjo22 committed Mar 23, 2024
1 parent 84bdbab commit dcc24a2
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 12 deletions.
11 changes: 2 additions & 9 deletions .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
- name: generate and deploy documentation
run: mkdocs gh-deploy -d https://mjo22.github.io/cryojax
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<h1 align='center'>cryoJAX</h1>

![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/).

Expand Down
3 changes: 1 addition & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -52,7 +51,7 @@ plugins:
show_source: false
members_order: source
heading_level: 4

nav:
- 'index.md'
- Examples:
Expand Down

0 comments on commit dcc24a2

Please sign in to comment.