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

DOCS: Refactor documentation examples #639

Merged
merged 20 commits into from
Jul 9, 2024
Merged

Conversation

SMoraisAnsys
Copy link
Collaborator

Rework the documentation to follow Markdown instead of reStructuredText.

Gains:

  • examples running as scripts
  • examples at the root of the repo and included to the documentation
  • examples runnings as notebook through JupyterLab

Copy link
Collaborator

@hui-zhou-a hui-zhou-a left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Good job!

Copy link
Collaborator

@svandenb-dev svandenb-dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thanks a lot !!

@SMoraisAnsys SMoraisAnsys merged commit 3b4e833 into main Jul 9, 2024
25 checks passed
@SMoraisAnsys SMoraisAnsys deleted the docs/refact-documentation branch July 9, 2024 06:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants