Skip to content

Commit

Permalink
Merge branch 'main' into feat/m2d_stress_tensor_field_calc
Browse files Browse the repository at this point in the history
  • Loading branch information
gmalinve authored Jun 20, 2024
2 parents d15bf0f + 143c180 commit a3b0098
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 86 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/ci_cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -205,11 +205,11 @@ jobs:
.venv\Scripts\Activate.ps1
.\doc\make.bat pdf
- name: Add assets to HTML docs
run: |
zip -r documentation-html.zip ./doc/_build/html
mv documentation-html.zip ./doc/_build/html/_static/assets/download/
cp doc/_build/latex/PyAEDT-Documentation-*.pdf ./doc/_build/html/_static/assets/download/pyaedt.pdf
# - name: Add assets to HTML docs
# run: |
# zip -r documentation-html.zip ./doc/_build/html
# mv documentation-html.zip ./doc/_build/html/_static/assets/download/
# cp doc/_build/latex/PyAEDT-Documentation-*.pdf ./doc/_build/html/_static/assets/download/pyaedt.pdf

- name: Upload HTML documentation with examples artifact
uses: actions/upload-artifact@v3
Expand Down
76 changes: 5 additions & 71 deletions .github/workflows/nightly-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,11 @@ jobs:
.venv\Scripts\Activate.ps1
.\doc\make.bat pdf
- name: Add assets to HTML docs
run: |
zip -r documentation-html.zip ./doc/_build/html
mv documentation-html.zip ./doc/_build/html/_static/assets/download/
cp doc/_build/latex/PyAEDT-Documentation-*.pdf ./doc/_build/html/_static/assets/download/pyaedt.pdf
# - name: Add assets to HTML docs
# run: |
# zip -r documentation-html.zip ./doc/_build/html
# mv documentation-html.zip ./doc/_build/html/_static/assets/download/
# cp doc/_build/latex/PyAEDT-Documentation-*.pdf ./doc/_build/html/_static/assets/download/pyaedt.pdf

- name: Upload HTML documentation with examples artifact
uses: actions/upload-artifact@v3
Expand All @@ -104,72 +104,6 @@ jobs:
path: doc/_build/latex/PyAEDT-Documentation-*.pdf
retention-days: 7

# doc-build-without-examples:
# name: Documentation build without examples
# runs-on: ubuntu-latest
# steps:
# - name: Install Git and checkout project
# uses: actions/checkout@v4

# - name: Setup Python
# uses: actions/setup-python@v5
# with:
# python-version: ${{ env.MAIN_PYTHON_VERSION }}

# - name: Update pip
# run: |
# pip install --upgrade pip

# - name: Install pyaedt and documentation dependencies
# run: |
# pip install .[doc-no-examples]

# - name: Retrieve PyAEDT version
# id: version
# run: |
# echo "PYAEDT_VERSION=$(python -c 'from pyaedt import __version__; print(__version__)')" >> $GITHUB_OUTPUT
# echo "PyAEDT version is: $(python -c "from pyaedt import __version__; print(__version__)")"

# - name: Install doc build requirements
# run: |
# sudo apt update
# sudo apt install graphviz texlive-latex-extra latexmk texlive-xetex texlive-fonts-extra -y

# # TODO: Update this step once pyaedt-examples is ready
# - name: Build HTML documentation without examples
# run: |
# make -C doc clean
# make -C doc html-no-examples

# # Verify that sphinx generates no warnings
# - name: Check for warnings
# run: |
# python doc/print_errors.py

# - name: Build PDF documentation without examples
# run: |
# make -C doc pdf-no-examples

# - name: Add assets to HTML docs
# run: |
# zip -r documentation-html.zip ./doc/_build/html
# mv documentation-html.zip ./doc/_build/html/_static/assets/download/
# cp doc/_build/latex/PyAEDT-Documentation-*.pdf ./doc/_build/html/_static/assets/download/pyaedt.pdf

# - name: Upload HTML documentation without examples artifact
# uses: actions/upload-artifact@v3
# with:
# name: documentation-no-examples-html
# path: doc/_build/html
# retention-days: 7

# - name: Upload PDF documentation without examples artifact
# uses: actions/upload-artifact@v3
# with:
# name: documentation-pdf
# path: doc/_build/latex/PyAEDT-Documentation-*.pdf
# retention-days: 7

upload-dev-doc:
name: Upload dev documentation
runs-on: ubuntu-latest
Expand Down
20 changes: 10 additions & 10 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -353,16 +353,16 @@ def setup(app):
},
}

# Add button to download PDF
html_theme_options["icon_links"].append(
{
"name": "Download documentation in PDF",
# NOTE: Changes to this URL must be reflected in CICD documentation build
"url": f"https://{cname}/version/{switcher_version}/_static/assets/download/pyaedt.pdf",
# noqa: E501
"icon": "fa fa-file-pdf fa-fw",
}
)
# # Add button to download PDF
# html_theme_options["icon_links"].append(
# {
# "name": "Download documentation in PDF",
# # NOTE: Changes to this URL must be reflected in CICD documentation build
# "url": f"https://{cname}/version/{switcher_version}/_static/assets/download/pyaedt.pdf",
# # noqa: E501
# "icon": "fa fa-file-pdf fa-fw",
# }
# )

html_static_path = ["_static"]

Expand Down

0 comments on commit a3b0098

Please sign in to comment.