Skip to content
New issue

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

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

Already on GitHub? # to your account

MkDocs Documentation #1

Merged
merged 16 commits into from
Sep 21, 2024
Merged

MkDocs Documentation #1

merged 16 commits into from
Sep 21, 2024

Conversation

mykolaskrynnyk
Copy link
Contributor

Summary

This requests adds package documentation made with Material for MkDocs.

New Features

  • Added documentation pages for installation, usage and reference.
  • Included an app preview GIF for the website and README.md.
  • Styled the documentation with the official logo, Proxima Nova fonts and design system colours.

Bug Fixes

None.

Checklist

  • I have read the contributing guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added required dependencies to pyproject.toml and updated poetry.lock (if applicable).
  • I have updated the documentation (if applicable).
  • I have included any necessary screenshots or examples of the new functionality.

Screenshots / Examples

None.

Additional Notes

Packages required for building documentation are included in dev group only.

@mykolaskrynnyk mykolaskrynnyk added the documentation Improvements or additions to documentation label Sep 21, 2024
@mykolaskrynnyk mykolaskrynnyk self-assigned this Sep 21, 2024
@mykolaskrynnyk mykolaskrynnyk merged commit 1bfa05b into main Sep 21, 2024
@mykolaskrynnyk mykolaskrynnyk deleted the mkdocs_documentation branch September 21, 2024 18:20
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant