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

Doc/jupyter examples #4144

Closed
wants to merge 63 commits into from
Closed
Show file tree
Hide file tree
Changes from 51 commits
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
2a28551
Update examples
Devin-Crawford Jan 28, 2024
7fd355c
Update css
Devin-Crawford Jan 28, 2024
a9a8f30
Update Example directories
Devin-Crawford Jan 28, 2024
d5afc27
Update Example directories
Devin-Crawford Jan 28, 2024
8da4fbe
DOC: fix EDB in 3D layout example
SMoraisAnsys Jan 29, 2024
5b020b5
Add pandoc installation
Devin-Crawford Jan 29, 2024
98a8a4b
FIX: doc build-finished doctree cleaning
SMoraisAnsys Jan 30, 2024
cdccd9b
FIX: revert action changes
SMoraisAnsys Jan 30, 2024
9ea63df
MISC: temporary remove actions to focus on fulldoc
SMoraisAnsys Jan 30, 2024
7dc1b0c
MISC: temporary update workflow trigger
SMoraisAnsys Jan 30, 2024
284f5a8
MISC: temporary removal to lighten doc
SMoraisAnsys Jan 30, 2024
742b64f
FIX: rename and refact example index
SMoraisAnsys Jan 30, 2024
2cb0099
FIX: examples removal on build error
SMoraisAnsys Jan 30, 2024
15ce0d8
FEAT: add example documentation build check
SMoraisAnsys Jan 30, 2024
3b5532f
DOC: fix code-block format
SMoraisAnsys Jan 30, 2024
e59503f
Update following code review
SMoraisAnsys Jan 30, 2024
5f3f656
Convert to md format
Devin-Crawford Jan 30, 2024
ba8447b
Convert to md format
Devin-Crawford Jan 30, 2024
3c68888
Convert to md format
Devin-Crawford Jan 31, 2024
008accc
Merge remote-tracking branch 'origin/doc/jupyter_examples' into doc/j…
Devin-Crawford Jan 31, 2024
1c13572
Convert to md format
Devin-Crawford Jan 31, 2024
98babc9
MISC: add fixed 00-EDB examples
SMoraisAnsys Jan 31, 2024
18ae1da
Convert to md format
Devin-Crawford Jan 31, 2024
69d45ca
Merge remote-tracking branch 'origin/doc/jupyter_examples' into doc/j…
Devin-Crawford Jan 31, 2024
1e0f3aa
Apply suggestions from code review
SMoraisAnsys Feb 1, 2024
3233439
Apply suggestions from code review
SMoraisAnsys Feb 1, 2024
831db92
Apply suggestions from code review
SMoraisAnsys Feb 1, 2024
74652b5
Apply suggestions from code review
SMoraisAnsys Feb 1, 2024
51a89bf
Apply suggestions from code review
SMoraisAnsys Feb 1, 2024
731add7
MISC: add example 08_CPWG.PY
SMoraisAnsys Feb 1, 2024
5fdb399
MISC: clean examples and add index.rst files
SMoraisAnsys Feb 1, 2024
0f7d443
DOC: convert 03-Maxwell into md
SMoraisAnsys Feb 1, 2024
4fd46f7
MISC: convert 04-Icepak into md
SMoraisAnsys Feb 1, 2024
c097778
MISC: use _static and md format for images
SMoraisAnsys Feb 1, 2024
23a4ff2
MISC: convert 05-Q3D into md
SMoraisAnsys Feb 1, 2024
540e18f
MISC: convert 06-Multiphysics
SMoraisAnsys Feb 3, 2024
4f72e43
Convert to md format
Devin-Crawford Feb 4, 2024
28e8e91
Convert to md format
Devin-Crawford Feb 4, 2024
0cecc3d
Convert to md format
Devin-Crawford Feb 4, 2024
3f527d1
MISC: Convert 07-Circuit to md format
Devin-Crawford Feb 4, 2024
1f326d8
MISC: Convert 07-EMIT to md format
Devin-Crawford Feb 4, 2024
9910b16
MISC: Convert 07-TwinBuilder to md format
Devin-Crawford Feb 4, 2024
9c878d5
Merge remote-tracking branch 'origin/doc/jupyter_examples' into doc/j…
Devin-Crawford Feb 4, 2024
52fdab5
MISC: Cleanup 07-TwinBuilder Examples
Devin-Crawford Feb 4, 2024
ca1567e
MISC: Cleanup 07-TwinBuilder Examples
Devin-Crawford Feb 4, 2024
b24b882
MISC: Cleanup 07-EMIT Examples
Devin-Crawford Feb 5, 2024
97e3962
FIX: Docstring in CircuitPins class
Devin-Crawford Feb 5, 2024
dfd1ab6
FIX: Docstring in CircuitPins class
Devin-Crawford Feb 5, 2024
45d0f10
MISC: 07-Circuit Examples cleanup.
Devin-Crawford Feb 5, 2024
facd169
MISC: Update 06-Multiphysics/Hfss_Icepak_Coupling.py
Devin-Crawford Feb 5, 2024
dfcc18b
Merge branch 'main' into doc/jupyter_examples
SMoraisAnsys Feb 6, 2024
730f311
WIP: use pypandoc-binary to avoid issues
SMoraisAnsys Feb 6, 2024
df929ae
MISC: fix examples
SMoraisAnsys Feb 7, 2024
e11b4f4
WIP: extend timeout for testing purposes
SMoraisAnsys Feb 7, 2024
18712de
WIP: temporary remove unit tests
SMoraisAnsys Feb 7, 2024
370005b
DOC: check pandoc installation and fail on error
SMoraisAnsys Feb 7, 2024
f9e1555
WIP: fix check pandoc
SMoraisAnsys Feb 7, 2024
9824354
Merge branch 'main' into doc/jupyter_examples
SMoraisAnsys Feb 7, 2024
a2c26d3
WIP: fix check pandoc
SMoraisAnsys Feb 7, 2024
2b68c12
WIP: temporary remove doc build
SMoraisAnsys Feb 7, 2024
c8d74f1
FIX: example format
SMoraisAnsys Feb 8, 2024
45e9479
Merge branch 'main' into doc/jupyter_examples
SMoraisAnsys Feb 9, 2024
c2fbe49
Merge branch 'main' into doc/jupyter_examples
MaxJPRey Feb 16, 2024
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
2 changes: 1 addition & 1 deletion .github/workflows/build_documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ jobs:

- name: Install doc build requirements
run: |
sudo apt install graphviz
sudo apt install -y graphviz pandoc

# run doc build, without creating the examples directory
# note that we have to add the examples file here since it won't
Expand Down
31 changes: 16 additions & 15 deletions .github/workflows/full_documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ env:
MEILISEARCH_HOST_URL: https://backend.search.pyansys.com
MEILISEARCH_PUBLIC_API_KEY: ${{ secrets.MEILISEARCH_PUBLIC_API_KEY }}
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the main branch
push:
tags:
- v*
workflow_dispatch:
inputs:
logLevel:
description: 'Log level'
required: true
default: 'warning'
tags:
description: 'Test scenario tags'
on: [pull_request, workflow_dispatch]
# # Triggers the workflow on push or pull request events but only for the main branch
# push:
# tags:
# - v*
# workflow_dispatch:
# inputs:
# logLevel:
# description: 'Log level'
# required: true
# default: 'warning'
# tags:
# description: 'Test scenario tags'

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down Expand Up @@ -71,7 +71,8 @@ jobs:
- name: Create HTML Documentations
run: |
testenv\Scripts\Activate.ps1
sphinx-build -j auto --color -b html -a doc/source doc/_build/html
cd doc
.\make.bat html

# - name: Create PDF Documentations
# run: |
Expand All @@ -93,7 +94,7 @@ jobs:
retention-days: 7

# - name: Upload PDF documentation artifact
# uses: actions/upload-artifact@v4
# uses: actions/upload-artifact@v3
# with:
# name: documentation-pdf
# path: doc/_build/pdf
Expand Down
40 changes: 0 additions & 40 deletions .github/workflows/ironpython.yml

This file was deleted.

133 changes: 0 additions & 133 deletions .github/workflows/nightly-docs.yml

This file was deleted.

103 changes: 0 additions & 103 deletions .github/workflows/unit_tests_solvers.bkp

This file was deleted.

Loading
Loading