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 <[email protected]>
OpenMDAO · Aug 31, 2023 · 42d9275 · 42d9275
1 parent b7e4cef
commit 42d9275
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 6 deletions.
diff --git 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
@@ -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
 ----------------------------------------