Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated GitHub workflow to upload documentation to web site #965

Merged
merged 4 commits into from
Aug 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 28 additions & 4 deletions .github/workflows/dymos_docs_workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
8 changes: 6 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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},
Expand All @@ -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
----------------------------------------
Expand Down