honey-team / ufpy

Ufpy (Useful Python) - package for Python with some useful features
https://honey-team.github.io/ufpy-website
MIT License
3 stars 3 forks source link

Init docs site #25

Closed bleudev closed 5 months ago

bleudev commented 5 months ago

closes #24

Summary by Sourcery

This pull request sets up a documentation site for the ufpy package using MkDocs with the Material theme. It includes configuration for Read the Docs, various MkDocs plugins, and markdown extensions. The documentation covers the UDict and UStack classes, generators, type checking protocols, and type aliases.

sourcery-ai[bot] commented 5 months ago

Reviewer's Guide by Sourcery

This pull request sets up the initial documentation site for the 'ufpy' package using MkDocs with the Material theme. It includes configuration files for MkDocs and Read the Docs, as well as initial documentation content for various features of the 'ufpy' package.

File-Level Changes

Files Changes
docs/useful_classes/udict.md
docs/useful_classes/ustack.md
Added documentation for useful classes 'UDict' and 'UStack'.
docs/type_checking/protocols.md
docs/type_checking/type_alias.md
Added documentation for type checking protocols and type aliases.
docs/source/conf.py
docs/source/index.md
Removed old Sphinx documentation files.

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - You can change your review settings at any time by accessing your [dashboard](https://sourcery.ai/dashboard): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
bleudev commented 5 months ago

Approved