Documentation: Adress Duplication, Chapter for KEMField Manual #97
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
This adds the Discussion & Getting Help section from the README to the documentation
This shortens the README.md, replacing most contents with links to the GH documentation. Small meeting and getting help fix
This adds back the email contacts to the README.md and combines the newly added Getting help section with Contacts/References
This commit aims to replace the license chapter with the License.md and adds a chapter for KEMField, including the manual.pdf. To implement the changes, Sphinx-SimplePDF and m2r2 for inclusion of markdown in .rst files have been added.
Documentation: KEMField Added short introduction and small changes to the presentation of the manual
These changes should allow proper presentation of the License.md using the .md parser for the sphinx documentation. Previously, the enumeration of segments failed in the .rst interpretation due to missing indentations.
2xB
approved these changes
Feb 13, 2024
|
LGTM, thanks! |
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.
This replaces parts of the README.md with links to the GitHub documentation and restructures a section for contact / references.
The license duplication has been adressed by loading the LICENSE.md directly into the documentation and a section including the KEMField Manual.pdf has been added.
To support the inclusion of .md and .pdf files with Sphinx, m2r2 and Sphinx-SimplePDF have been added. Additionally, small formatting changes have been done to the LICENSE.md to improve the representation in the documentation after being parsed to .rst.