Mechanical stubs to sphinx documentation #1
Merged
Conversation
This file contains 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
Closed
RobPasMue
reviewed
Aug 24, 2023
RobPasMue
reviewed
Aug 24, 2023
koubaa
reviewed
Aug 24, 2023
koubaa
reviewed
Aug 24, 2023
koubaa
approved these changes
Aug 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Created mechanical API documentation from the mechanical stubs generated by main.py.
Added package directory containing doc and doc/source folders to create sphinx documentation from docstrings.
Adjusted main.py to create source code docstrings directory in "package/src/Ansys" instead of "out/Ansys"
Added fix_str function to gen.py to remove `1 from docstrings
Added encoding to init.py scripts that are created in gen.py
Added pre-commit checks to the repository.
doc - contains Makefile, make.bat, and source folder. Run "make html" in this directory to create sphinx documentation from package/src/Ansys
doc/source - contains conf.py, autoapi template and index.rst files for creation of sphinx documentation from package/src/Ansys