Closed bleudev closed 5 months ago
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.
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. |
Approved
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 theUDict
andUStack
classes, generators, type checking protocols, and type aliases.UDict
andUStack
classes, various generators, type checking protocols, and type aliases.ufpy
package, installation instructions, and usage examples.UDict
,UStack
, generators, type checking protocols, and type aliases.