Skip to content

Commit

Permalink
Convert md tutorials to rst and copy them to the website (#95)
Browse files Browse the repository at this point in the history
* tutorials are now build and cc to the website

* Same action for building docs and website

* Fixing rendering

* Correct use of artifacts upload/download

* Adding back index for tutorials

* The sphinx-tutorial formula is not required anymore [skip ci]

* Chrome present in GHA allows rendering mermaid

* Fixed figures

* Improving readability

* Updating lock file

* Update model/src/pyrenew/latent/hospitaladmissions.py

Co-authored-by: Dylan H. Morris <dylanhmorris@users.noreply.github.com>

* Fixing pre-commit

---------

Co-authored-by: Dylan H. Morris <dylanhmorris@users.noreply.github.com>
  • Loading branch information
gvegayon and dylanhmorris authored May 3, 2024
1 parent a7c1349 commit c8e7daf
Show file tree
Hide file tree
Showing 128 changed files with 556 additions and 4,025 deletions.
38 changes: 0 additions & 38 deletions .github/workflows/docs.yaml

This file was deleted.

48 changes: 47 additions & 1 deletion .github/workflows/website.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,46 @@ permissions:
id-token: write

jobs:
render-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: quarto-dev/quarto-actions/setup@v2

- uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: cache poetry
uses: actions/cache@v4
with:
path: ~/.local
key: ${{ runner.os }}-poetry

- name: install poetry
run: pip install poetry

- name: install package
run: poetry install --with dev -C model

- name: Render documents
run: |
cd model
mkdir _compiled
for file in $(find docs -name '*.qmd'); do
poetry run quarto render $file --to rst --output-dir ../_compiled
done
# Upload
- name: Upload artifacts
uses: actions/upload-artifact@v3
with:
name: tutorials
path: model/_compiled/

build:
needs: render-docs
runs-on: ubuntu-latest
permissions:
contents: write
Expand All @@ -26,6 +65,13 @@ jobs:
- name: Setup Pages
uses: actions/configure-pages@v4

# Load the artifact github-pages-tutorials
- name: Download artifacts
uses: actions/download-artifact@v3
with:
name: tutorials
path: docs/source/tutorials/

- name: Set up Python
uses: actions/setup-python@v5
with:
Expand Down Expand Up @@ -67,4 +113,4 @@ jobs:
uses: actions/deploy-pages@v4
with:
artifact_name: github-pages
preview: false # Not yet available to the public.
preview: true # Not yet available to the public.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
[![installation and testing pipeline](https://github.com/CDCgov/multisignal-epi-inference/actions/workflows/pipeline.yaml/badge.svg)](https://github.com/CDCgov/multisignal-epi-inference/actions/workflows/pipeline.yaml)
[![Docs: model](https://github.com/CDCgov/multisignal-epi-inference/actions/workflows/website.yaml/badge.svg)](https://github.com/CDCgov/multisignal-epi-inference/actions/workflows/website.yaml)
[![codecov (model)](https://codecov.io/gh/CDCgov/multisignal-epi-inference/graph/badge.svg?token=7Z06HOMYR1)](https://codecov.io/gh/CDCgov/multisignal-epi-inference)
[![Quarto documents](https://github.com/CDCgov/multisignal-epi-inference/actions/workflows/docs.yaml/badge.svg)](https://github.com/CDCgov/multisignal-epi-inference/actions/workflows/docs.yaml)


This repo hosts the multisignal (*a.k.a.* signal fusion) renewal project: an internal forecasting model that leverages multiple data sources for enhancing epidemiological modeling of infectious disease outbreaks.
Expand Down
Binary file removed docs/build/doctrees/bugs.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/contribute.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/ctoc.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file removed docs/build/doctrees/faq.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/general/bugs.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/general/contribute.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/general/ctoc.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/general/faq.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/general/glossary.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/general/index.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/general/license.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/general/notices.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/general/state.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/general/usage.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/genindex.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/glossary.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/index.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/license.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/modindex.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/msei_reference/basic.doctree
Binary file not shown.
Binary file not shown.
Binary file removed docs/build/doctrees/msei_reference/distutil.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/msei_reference/index.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/msei_reference/infection.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/msei_reference/latent.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/msei_reference/math.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/msei_reference/model.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/msei_reference/msei.doctree
Binary file not shown.
Binary file not shown.
Binary file removed docs/build/doctrees/msei_reference/process.doctree
Binary file not shown.
Binary file not shown.
Binary file removed docs/build/doctrees/msei_reference/transform.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/notices.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/observation.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/reference.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/reference/index.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/reference/observation.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/search.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/state.doctree
Binary file not shown.
Binary file removed docs/build/doctrees/test_reference/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/build/doctrees/usage.doctree
Binary file not shown.
4 changes: 0 additions & 4 deletions docs/build/html/.buildinfo

This file was deleted.

Empty file removed docs/build/html/.nojekyll
Empty file.
52 changes: 0 additions & 52 deletions docs/build/html/_sources/bugs.rst.txt

This file was deleted.

10 changes: 0 additions & 10 deletions docs/build/html/_sources/contribute.rst.txt

This file was deleted.

12 changes: 0 additions & 12 deletions docs/build/html/_sources/ctoc.rst.txt

This file was deleted.

6 changes: 0 additions & 6 deletions docs/build/html/_sources/faq.rst.txt

This file was deleted.

52 changes: 0 additions & 52 deletions docs/build/html/_sources/general/bugs.rst.txt

This file was deleted.

10 changes: 0 additions & 10 deletions docs/build/html/_sources/general/contribute.rst.txt

This file was deleted.

21 changes: 0 additions & 21 deletions docs/build/html/_sources/general/ctoc.rst.txt

This file was deleted.

6 changes: 0 additions & 6 deletions docs/build/html/_sources/general/faq.rst.txt

This file was deleted.

12 changes: 0 additions & 12 deletions docs/build/html/_sources/general/glossary.rst.txt

This file was deleted.

17 changes: 0 additions & 17 deletions docs/build/html/_sources/general/license.rst.txt

This file was deleted.

37 changes: 0 additions & 37 deletions docs/build/html/_sources/general/notices.rst.txt

This file was deleted.

6 changes: 0 additions & 6 deletions docs/build/html/_sources/general/state.rst.txt

This file was deleted.

6 changes: 0 additions & 6 deletions docs/build/html/_sources/general/usage.rst.txt

This file was deleted.

4 changes: 0 additions & 4 deletions docs/build/html/_sources/genindex.rst.txt

This file was deleted.

12 changes: 0 additions & 12 deletions docs/build/html/_sources/glossary.rst.txt

This file was deleted.

Loading

0 comments on commit c8e7daf

Please sign in to comment.