Skip to content

Commit

Permalink
UDict docs (#7)
Browse files Browse the repository at this point in the history
This pull request updates the documentation for the `UDict` class,
introduces the new `uSTL` package with initial documentation for the
`Stack` class, and deprecates the `UStack` class. It also enhances the
MkDocs theme configuration and simplifies the CI workflow for
documentation deployment.

- **New Features**:
- Introduced `uSTL` package with initial documentation for `Stack`
class.
- **Enhancements**:
- Updated `UDict` documentation to improve clarity and consistency,
including better formatting and additional examples.
    - Added a logo to the MkDocs theme configuration.
- Enhanced MkDocs theme with new features like content code annotation
and updated navigation settings.
- **CI**:
- Simplified the GitHub Actions workflow for deploying MkDocs by
removing specific branch restrictions.
- **Documentation**:
- Deprecated `UStack` class in favor of `uSTL.Stack` and updated its
documentation accordingly.
- Updated the main index documentation to reflect the new structure and
features, including the `uSTL` package and its components.
  • Loading branch information
bleudev authored Jul 5, 2024
1 parent 81735e7 commit a997d6d
Show file tree
Hide file tree
Showing 10 changed files with 357 additions and 66 deletions.
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

0 comments on commit a997d6d

Please sign in to comment.