Skip to content

Commit

Permalink
Update documents.
Browse files Browse the repository at this point in the history
  • Loading branch information
ivanklee86 committed Apr 5, 2023
1 parent 9380ed7 commit 004174c
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 2 deletions.
4 changes: 4 additions & 0 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ Running Tox locally
4. Run ``make install`` to get latest local dependencies.
5. Run ``make tox`` to run tox.

Using devcontainer
###########################################
This SDK ships with a devcontainer to make local (or cloud!) environment fast & easy!

Upgrading the Client Specification Tests
###########################################
This SDK implements tests for the `Unleash Client Specifications <https://github.com/Unleash/client-specification>`_,
Expand Down
5 changes: 5 additions & 0 deletions docs/events.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
****************************************
Events
****************************************

.. autoclass:: UnleashClient.events.UnleashEvent
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Documentation for Unleash's Python client. See the sidebar for more topics!
strategy
filecache
basecache
events

.. toctree::
:caption: Changelog
Expand Down
2 changes: 0 additions & 2 deletions docs/strategy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Strategy

.. automethod:: execute

.. automethod:: load_constraints

.. automethod:: load_provisioning

.. automethod:: apply

0 comments on commit 004174c

Please sign in to comment.