From 42d92755fba9de748da1d2a43e234066fc41dbd5 Mon Sep 17 00:00:00 2001 From: swryan <881430+swryan@users.noreply.github.com> Date: Thu, 31 Aug 2023 11:12:08 -0400 Subject: [PATCH] Updated GitHub workflow to upload documentation to web site (#965) * upload doc versions * Update readme with new links for documentation * clean up readme * dev version of jbook no longer needed --------- Co-authored-by: swryan --- .github/workflows/dymos_docs_workflow.yml | 32 ++++++++++++++++++++--- readme.md | 8 ++++-- 2 files changed, 34 insertions(+), 6 deletions(-) diff --git a/.github/workflows/dymos_docs_workflow.yml b/.github/workflows/dymos_docs_workflow.yml index 0cfc6135f..8f652ddaa 100644 --- a/.github/workflows/dymos_docs_workflow.yml +++ b/.github/workflows/dymos_docs_workflow.yml @@ -228,8 +228,8 @@ jobs: echo "=============================================================" echo "Building Docs" echo "=============================================================" - pip install git+https://github.com/executablebooks/jupyter-book cd docs + export PYDEVD_DISABLE_FILE_VALIDATION=1 jupyter-book build -W --keep-going dymos_book python copy_build_artifacts.py @@ -245,16 +245,40 @@ jobs: -exec echo "#################################################################" \; \ -exec cat {} \; - - name: Publish docs + - name: Publish docs to github.io if: | github.event_name == 'push' && github.ref == 'refs/heads/master' && matrix.PUBLISH_DOCS == '1' shell: bash -l {0} run: | echo "=============================================================" - echo "Publishing Docs" + echo "Publishing Docs to github.io" echo "=============================================================" pip install ghp-import cd $HOME/work/dymos/dymos - pwd ghp-import -n -p -f docs/dymos_book/_build/html + + + - name: Publish docs to openmdao.org + if: | + github.event_name == 'push' && github.ref == 'refs/heads/master' && + matrix.PUBLISH_DOCS == '1' + env: + DOCS_LOCATION: ${{ secrets.DOCS_LOCATION }} + shell: bash -l {0} + run: | + if [[ "${#DOCS_LOCATION}" ]]; then + echo "=============================================================" + echo "Install version of openssl compatible with hosting service" + echo "=============================================================" + conda install -c conda-forge 'openssl=3.0' + + echo "=============================================================" + echo "Publishing Docs to openmdao.org" + echo "=============================================================" + echo "Publish docs" + cd $HOME/work/dymos/dymos + python -m openmdao.docs.upload_doc_version docs/dymos_book/_build/html/ ${{ secrets.DOCS_LOCATION }} + else + echo "Docs destination not available." + fi diff --git a/readme.md b/readme.md index 955fab570..154ccd21d 100644 --- a/readme.md +++ b/readme.md @@ -30,7 +30,7 @@ Citation See our [overview paper](https://joss.theoj.org/papers/10.21105/joss.02809) in the Journal of Open Source Software -If you use Dymos in your work, please cite: +If you use Dymos in your work, please cite: ``` @article{Falck2021, doi = {10.21105/joss.02809}, @@ -51,7 +51,11 @@ If you use Dymos in your work, please cite: Documentation ------------- -Online documentation is available at [https://openmdao.github.io/dymos/](https://openmdao.github.io/dymos/) +Documentation for the current development version of Dymos is available at +[https://openmdao.github.io/dymos/](https://openmdao.github.io/dymos/) as well as on the OpenMDAO web site: +[https://openmdao.org/dymos/docs/latest/](https://openmdao.org/dymos/docs/latest/). +Archived versions for recent releases will also be found here: +[https://openmdao.org/dymos-documentation/](https://openmdao.org/dymos-documentation/) Defining Ordinary Differential Equations ----------------------------------------