Docs for Graph.
[pyutils.git] / docs / pyutils.rst
index 7d19ab70d7e5cd236d154cbdad4a8e0d4f53fbc7..3581bef6ca93e7e57be83d497ef66d313cae3d50 100644 (file)
@@ -41,6 +41,11 @@ stable:
     - overrides: code decorator to mark and enforce method overrides.
     - pytz: Python timezones, used in date parser and utils.
 
+You can also install the wheel directly; the latest is checked in under: https://wannabe.guru.org/gitweb/?p=pyutils.git;a=tree;f=dist;hb=HEAD.  To do so, download it, check that the MD5
+matches, and run::
+
+    pip install <filename.whl>
+
 Development
 -----------
 
@@ -83,6 +88,7 @@ To actually build the code (by which I mean type check it, lint it, package it,
 it, etc...) you need some other dependencies installed:
 
     - black: I use black to auto-format the code
+    - mypy: a Python type checker
     - coverage: used by the --coverage option of `run_tests.py`.
     - flake8: a Python linter
     - pylint: another Python linter
@@ -2310,6 +2316,14 @@ pyutils.function\_utils module
    :undoc-members:
    :show-inheritance:
 
+pyutils.graph module
+------------------------------
+
+.. automodule:: pyutils.graph
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 pyutils.id\_generator module
 ----------------------------