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.

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

Final touch to the documentation after update to 2.0 #73

Merged
merged 6 commits into from
Nov 21, 2023

Conversation

WeisLeDocto
Copy link
Member

This PR brings a final touch to the documentation of Crappy, that has already been greatly completed and enhanced by #52. As detailed in #66, this PR contains the following improvements:

  • Use the kbd directive when describing a keyboard combination
  • Use the versionadded, versionchanged and versionremoved directives for signaling the version when a class, method, or argument was added, changed, or removed
  • Add sectionauthor directives for signaling the author(s) of documentation sections
  • Add the link to numpy, matplotlib, and psutil documentation in intersphinx
  • Add collapse menus to the documentation for hiding large sections of code

The changes will be included in version 2.0.1.
This PR closes #66.

@WeisLeDocto WeisLeDocto added the documentation Missing, incorrect or incomplete documentation label Nov 20, 2023
@WeisLeDocto WeisLeDocto self-assigned this Nov 20, 2023
@WeisLeDocto WeisLeDocto linked an issue Nov 20, 2023 that may be closed by this pull request
6 tasks
@WeisLeDocto WeisLeDocto merged commit 191914d into develop Nov 21, 2023
1 check passed
@WeisLeDocto WeisLeDocto deleted the feature/doc_improvement_for_v2.0.1 branch November 21, 2023 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Missing, incorrect or incomplete documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Further improve the documentation
2 participants