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

UDict docs #7

Merged
merged 14 commits into from
Jul 5, 2024
7 changes: 3 additions & 4 deletions .github/workflows/deploy_mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
name: deploy_mkdocs
on:
push:
branches:
- master
- main
push

permissions:
contents: write

jobs:
deploy:
runs-on: ubuntu-latest
Expand Down
Binary file added docs/assets/images/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 5 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,12 @@ Ufpy (Useful Python) - is a package for simplifying Python programs using many u
Now Ufpy has these features:

- [`UDict`](useful_classes/udict.md "Useful dict.").
- [`UStack`](useful_classes/ustack.md "Useful stack.").
- [`uSTL` package](uSTL/index.md).
- [`Stack`](uSTL/stack.md).
- Generators of classes methods:
- [`cmp_generator`](generators.md "Compare generator. In latest python version were deleted __cmp__ method. With this generator you can use __cmp__ in your class")
- [`r_generator`](generators.md "Reverse generator. Generating __r...__ methods for math operations")
- [`i_generator`](generators.md "I methods generator. Generating __i...__ method for math operations")
- [`cmp_generator`](useful_features/generators.md "Compare generator. In latest python version were deleted __cmp__ method. With this generator you can use __cmp__ in your class")
- [`r_generator`](useful_features/generators.md "Reverse generator. Generating __r...__ methods for math operations")
- [`i_generator`](useful_features/generators.md "I methods generator. Generating __i...__ method for math operations")
- [many protocols for type hinting.](type_checking/protocols.md)
- [many type alias for type hinting.](type_checking/type_alias.md)

Expand Down
7 changes: 7 additions & 0 deletions docs/uSTL/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Introduction

{--
`uSTL` package is ...
--}

Under development!
8 changes: 8 additions & 0 deletions docs/uSTL/stack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Stack[VT]

tags:
- uSTL
---

# class Stack[VT]
Loading