Improve documentation #303
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.
Added docstrings to more functions.
Added Python script that can be used to generate docs.h for documenting the pybind later by extracting docstrings from .h files.
Allowed python and cpp docs to be built separately, with an alternative build available that adds the styling from fenicsproject.org.
Added notes stating which functions are designed to be called at runtime.
Moved lots of finite element functions inside the
elementnamespace to reduce the number of functions in thebasixnamespace.Fixes #45. Fixes #266. Fixes #296. Fixes #98. Fixes #275. Progress towards FEniCS/web#11.