Regenerate markdown user manual from docstrings #2386
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
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.
#2385 applied changes to
Python_User_Interface.md, a file which is automatically generated fromPython_User_Interface.md.inusing the Python docstrings. Unfortunately, any manual editing ofPython_User_Interface.mdcan therefore be lost.This PR applies the changes from #2385 to the docstrings for
MaterialGridingeom.pywith some modifications (mainly for consistency with the rest of the documentation). Also, the markdown user manual is regenerated viamake python_api_doc. As a result, this PR contains additional changes to the user manual including from several recently added features (GaussianBeam2Dsource,Simulation.timestep, etc).