feat(docs): Add sphinx theme and tools #79 #80
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
* The documentation will be re-written and conform to the Diataxis https://diataxis.fr/ document framework. These tools make that process much more manageable. * Add these tools and theme. - furo: Sphinx theme. - myst-parser: Parsing markdown. - sphinx-copybutton: Copy code examples with a button. - sphinx_inline_tabs: Use tabs to provide additional context. closes #79
imAsparky
added this to In progress
in Modify the original fork to suit my needs
via automation
imAsparky
moved this from In progress
to Done
in Modify the original fork to suit my needs
imAsparky
added this to In progress
in Improve User experience for the cookiecutter-py3-package documentation.
via automation
imAsparky
moved this from In progress
to Done
in Improve User experience for the cookiecutter-py3-package 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.
Diataxis https://diataxis.fr/ document framework.
These tools make that process much more manageable.
closes #79