Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[FEAT]: Update cookiecutter-p3-package sphinx theme, and add documentation tools. #79

Closed
imAsparky opened this issue Sep 15, 2021 · 0 comments · Fixed by #80
Closed

[FEAT]: Update cookiecutter-p3-package sphinx theme, and add documentation tools. #79

imAsparky opened this issue Sep 15, 2021 · 0 comments · Fixed by #80
Assignees
@imAsparky
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Modify the original fork to suit my n... Improve User experience for the cooki...

Comments

@imAsparky
Copy link
Owner

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

The additional sphinx tools will provide more flexibility to improve the documents user experience.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Add these tools and theme.

furo: Sphinx theme.
myst-parser: Parsing markdown.
sphinx-copybutton: Copy code examples with a button.
sphinx_inline_tabs: Use tab to provide additional context.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

The documentation will be re-written into the Diataxis https://diataxis.fr/ document framework. These tools make that process much more manageable.
@imAsparky imAsparky added the enhancement New feature or request label Sep 15, 2021
@imAsparky imAsparky self-assigned this Sep 15, 2021
@imAsparky imAsparky added this to To do in Modify the original fork to suit my needs via automation Sep 15, 2021
imAsparky added a commit that referenced this issue Sep 15, 2021
@imAsparky
feat(docs): Add sphinx theme and tools #79
ad6d3c9 
* 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 imAsparky mentioned this issue Sep 15, 2021
Merged
Modify the original fork to suit my needs automation moved this from To do to Done Sep 15, 2021
imAsparky added a commit that referenced this issue Sep 15, 2021
@imAsparky
feat(docs): Add sphinx theme and tools #79 (#80)
60a9388 
* 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 imAsparky added the documentation Improvements or additions to documentation label Sep 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@imAsparky imAsparky

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Improve User experience for the cooki...
Done
Modify the original fork to suit my n...
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(docs): Add sphinx theme and tools #79 imAsparky/cookiecutter-py3-package
1 participant
@imAsparky