Update documentation

AktechLabs · Sep 8, 2023 · a53938c · a53938c
commit a53938c
Show file tree

Hide file tree

Showing 31 changed files with 3,693 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 3fb45b8e04549525f62c6170296cd61d
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -0,0 +1,7 @@
+.. _api:
+
+Cirun
+--------------
+
+.. autoclass:: cirun.Cirun
+   :members:
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,23 @@
+Welcome to PyDSA's documentation!
+=================================
+
+PyDSA is a Python Data Structure and Algorithms Library (α-mode).
+It is currently in it's initial phase of development.
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+
+
+Contributing
+============
+
+There are multiple ways you can contibute to Pydsa
+
+* Add missing documentation.
+* Add/improve efficiency of algorithms or Data structures.
+* Report bugs.
+* Request/Submit new algorithms.
+
+Use github's Pull request/issues feature for all contributions.