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.

Sign up for GitHub

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

Jump to bottom

DOCS: Rework example documentation #43

Merged

SMoraisAnsys merged 18 commits into main from docs/refactor-examples

May 31, 2024

Contributor

SMoraisAnsys commented May 30, 2024

This PR adds an "Examples" section to the documentation.

The current approach followed is to use a python file such that:

examples are at root level of the repo (easier to find for users)
examples can be executed as python scripts (with some extra labels to help following bullet point)
examples can be run as notebooks with jupyterlab (you would see texte cells and code cells)

Closes #42

SMoraisAnsys and others added 2 commits

May 30, 2024 18:11


          DOCS: Rework example documentation

4bb914f


          Merge branch 'main' into docs/refactor-examples

b75e624

github-actions bot added maintenance documentation labels


          Adding changelog entry: 43.changed.md

b57fba8

github-actions bot added documentation and removed documentation labels

SMoraisAnsys added 2 commits

May 30, 2024 18:22


          CHORE: Update poetry lock file

7b3cf8a


          CI: Remove unused env var

fd46588

github-actions bot added documentation and removed documentation labels


          CI: Use env var in build doc job

cf46be9

github-actions bot added documentation and removed documentation labels


          DOCS: Use recommonmark for parsing

d0dfb45

github-actions bot added documentation and removed documentation labels

SMoraisAnsys added 2 commits

May 31, 2024 09:25


          DOCS: Fix warnings

abcf9af


          CHORE: Move dependency to doc group

fa290ea

github-actions bot added documentation and removed documentation labels


          CHORE: Update poetry lock file

8b41bfb

github-actions bot added documentation and removed documentation labels


          WIP: Fix PDF documentation build

ad4abdc

github-actions bot added documentation and removed documentation labels


          DOCS: Use xelatex to avoid tex capacity

d6b3593

github-actions bot added documentation and removed documentation labels

SMoraisAnsys added 2 commits

May 31, 2024 10:10


          CI: Fix coverage artifact name

a7a8303


          DOCS: Rework example

3ac4c40

github-actions bot added documentation and removed documentation labels


          DOCS: Rework example

779abca

github-actions bot added documentation and removed documentation labels


          DOCS: Rework example

b6b2954

github-actions bot added documentation and removed documentation labels

Contributor Author

SMoraisAnsys commented May 31, 2024

@philipjusher Think we converged with something working, could you have a look ?

philipjusher previously approved these changes

View reviewed changes


          CHORE: Fix documentation link

c14381f

SMoraisAnsys dismissed philipjusher’s stale review via

c14381f

May 31, 2024 12:16


          CHORE: Fix documentation link

dca54af

github-actions bot added documentation and removed documentation labels

SMoraisAnsys merged commit 23cbd8a into main

31 checks passed

SMoraisAnsys deleted the docs/refactor-examples branch

May 31, 2024 12:56

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation maintenance