From 19e27de268d89f31ce2a9186746efbe11249cdd4 Mon Sep 17 00:00:00 2001 From: swryan Date: Mon, 14 Aug 2023 14:57:25 -0400 Subject: [PATCH 1/4] upload doc versions --- .github/workflows/dymos_docs_workflow.yml | 31 ++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/.github/workflows/dymos_docs_workflow.yml b/.github/workflows/dymos_docs_workflow.yml index 0cfc6135f..231ab7de9 100644 --- a/.github/workflows/dymos_docs_workflow.yml +++ b/.github/workflows/dymos_docs_workflow.yml @@ -230,6 +230,7 @@ jobs: 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 +246,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 From b8f6198bed3d4314623ea9587b00e90b8f386fe7 Mon Sep 17 00:00:00 2001 From: swryan Date: Tue, 15 Aug 2023 12:38:20 -0400 Subject: [PATCH 2/4] Update readme with new links for documentation --- readme.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 955fab570..b73faa150 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/index.html](https://openmdao.org/dymos/docs/latest/index.html). +Archived versions for recent releases will be found here: +[https://openmdao.org/dymos-documentation/](https://openmdao.org/dymos-documentation/) Defining Ordinary Differential Equations ---------------------------------------- From d62a12532d78fa70746046e275a2baab15d1a9db Mon Sep 17 00:00:00 2001 From: swryan Date: Tue, 15 Aug 2023 12:44:50 -0400 Subject: [PATCH 3/4] clean up readme --- readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index b73faa150..154ccd21d 100644 --- a/readme.md +++ b/readme.md @@ -53,8 +53,8 @@ Documentation 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/index.html](https://openmdao.org/dymos/docs/latest/index.html). -Archived versions for recent releases will be found here: +[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 From 2f849edceba429878cccc5a550b73b1f666edc31 Mon Sep 17 00:00:00 2001 From: swryan Date: Wed, 16 Aug 2023 11:48:39 -0400 Subject: [PATCH 4/4] dev version of jbook no longer needed --- .github/workflows/dymos_docs_workflow.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/dymos_docs_workflow.yml b/.github/workflows/dymos_docs_workflow.yml index 231ab7de9..8f652ddaa 100644 --- a/.github/workflows/dymos_docs_workflow.yml +++ b/.github/workflows/dymos_docs_workflow.yml @@ -228,7 +228,6 @@ 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