Init docs site

[bleudev]

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.

• New Features:
  • Initialized a documentation site using MkDocs with the Material theme.
  • Added documentation for the UDict and UStack classes, various generators, type checking protocols, and type aliases.
• Enhancements:
  • Configured MkDocs with various plugins and markdown extensions to enhance the documentation site.
• Build:
  • Added a Read the Docs configuration file to automate the build and deployment of the documentation site.
• Documentation:
  • Created an index page with an introduction to the ufpy package, installation instructions, and usage examples.
  • Added individual documentation pages for UDict, UStack, generators, type checking protocols, and type aliases.

[sourcery-ai]

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:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[sourcery-ai]

Привет, @bleudev - я просмотрел ваши изменения, и они выглядят отлично!

Вот что я рассмотрел во время проверки

• 🟡 Общие проблемы: найдено 7 проблем
• 🟢 Безопасность: все выглядит хорошо
• 🟢 Тестирование: все выглядит хорошо
• 🟢 Сложность: все выглядит хорошо

---

Sourcery бесплатен для open source - если вам нравятся наши обзоры, пожалуйста, подумайте о том, чтобы поделиться ими ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Помогите мне быть полезнее! Пожалуйста, нажмите 👍 или 👎 на каждый комментарий, чтобы сообщить, был ли он полезен.}

Original comment in English

Hey @bleudev - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 7 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[bleudev]

Approved