Huge Improvement of Documentation #61
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
As the number of files in the RDMC repo keep growing, it makes more sense to keep a hierarchical structure for API references, instead of putting everything under the `/source` directly.
using `::` and extra empty line to create a block
Add code-block for demonstration of the default argument of style_spec
1. Change the theme to pydata; 2. Change how Returns is displayed 3. Auto update year
1. Update the index with new introduction paragraph, installation guide, developer information 2. add a how to cite page 3. add a credits page 4. add developer's social media info
Initiate with the align submodule with corrected docstring.
1. Create a section of embedding geometries 2. Update the docstrings of embedders and ts_guessers
Add a section called "Geometry Optimization", and clean up the docstrings in the optimizers.py and ts_optimizers.py
Add rst file and clean the docstrings
1. docs are added for pruners, verifiers, ts_verifiers, and solvation 2. relevant docstrings are cleaned
Add rst files and clean up docstrings
xiaoruiDong
added
documentation
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.
Motivation or Problem
The previous documentation is outdated, with an obsolete description of RDMC and missing API references to a few modules.
Description of Changes
/docsconformer_generationmodule,mathlibmodule, andreactionmoduleTesting
The new documentation is tested by building sphinx documents locally.