Add section for molecular writers to TOC #350
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
lukasturcani
force-pushed
the
lukas/add-writers-section-patch
branch
from
bda61e8
to
2b407f4
Compare
Related Issues: #299 This commit adds a new section to the TOC in the documentation for the molecular writers. For the table of contents holding the molecular writers, I added a new file, `docs/source/writers.rst`, rather than adding the TOC into the `src/stk/molecular/writers/__init__.py` because that file automatically adds a second TOC, which contains a list of the subpackages. I want the page to only show the single TOC I'm adding, and having a separate file makes this easier to configure. Also, this is what I did for `docs/source/mutation.rst` and `docs/source/polymer.rst` so it's consistent.
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.
Related Issues: #299
This commit adds a new section to the TOC in the documentation for
the molecular writers. For the table of contents holding the
molecular writers, I added a new file,
docs/source/writers.rst,rather than adding the TOC into the
src/stk/molecular/writers/__init__.pybecause that fileautomatically adds a second TOC, which contains a list of the
subpackages. I want the page to only show the single TOC I'm adding,
and having a separate file makes this easier to configure. Also, this
is what I did for
docs/source/mutation.rstanddocs/source/polymer.rstso it's consistent.