Add quick start and tutorials to documentation#111
Merged
Conversation
Introduced 'quick_start.rst' and 'tutorials.rst' with comprehensive usage guides and examples. Updated 'index.rst' to include new sections in the table of contents. Enhanced the build-docs workflow to support artifact upload and deployment for main/master branches and pull requests.
Introduced concurrency groups to all major GitHub Actions workflows to prevent overlapping runs and automatically cancel in-progress jobs for the same workflow and ref. This helps optimize CI resource usage and ensures only the latest workflow runs are executed.
Introduced concurrency groups to mmg and neper packaging GitHub Actions workflows to prevent overlapping runs and cancel in-progress jobs for the same workflow and ref.
Update tutorials to export CAD shapes to a STEP file before meshing and adjust microgen mesh examples accordingly. Added cadquery imports, export of Workplane to 'gyroid.step', replaced cad=shape with mesh_file='gyroid.step', added order parameter to mesh calls, and created a Phase object with list_phases for the periodic mesh example. Also fixed a small cross-reference text in quick_start.rst (changed to 'RST 3Dop').
Remove the blackdoc pre-commit hook from .pre-commit-config.yaml and enable Ruff's docstring code formatting by adding [tool.ruff.format] docstring-code-format = true to pyproject.toml. This switches docstring code formatting to Ruff and cleans up the pre-commit configuration.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces improvements to the documentation workflow and content. The main changes include enhancing the GitHub Actions workflow for building and deploying documentation, updating the table of contents, and adding a new quick-start guide.
Documentation workflow enhancements:
.github/workflows/build-docs.ymlworkflow now triggers on pushes and pull requests tomainandmaster, as well as on manual dispatch. It uploads built HTML documentation as an artifact and deploys documentation to a separate branch for each pull request and to themainbranch for merges tomain/master. [1] [2]Documentation content improvements:
quick_start.rstfile with a comprehensive Quick-Start Guide, including step-by-step instructions and executable code snippets for getting started with Microgen.index.rsttable of contents to include links to the new quick start and tutorials sections.Introduced 'quick_start.rst' and 'tutorials.rst' with comprehensive usage guides and examples. Updated 'index.rst' to include new sections in the table of contents. Enhanced the build-docs workflow to support artifact upload and deployment for main/master branches and pull requests.