Added Documentation using Sphinx to the project

2025-05-20 02:40:54 -03:00 · 2025-05-20 02:40:54 -03:00 · 3aa86298bb
parent 41ae7bb43e
commit 3aa86298bb
4 changed files with 22 additions and 0 deletions
--- a/docs/source/goulag_sort_detailed_explanation.rst
+++ b/docs/source/goulag_sort_detailed_explanation.rst
@ -0,0 +1,4 @@
+.. _goulag_sort_detailed_explanation:
+
+Goulag Sort Explained
+========================
--- a/docs/source/goulagsort_package.rst
+++ b/docs/source/goulagsort_package.rst
@ -0,0 +1,8 @@
+goulag_sort Package
+===================
+
+.. automodule:: goulag_sort
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
--- a/docs/source/modules.rst
+++ b/docs/source/modules.rst
@ -0,0 +1,7 @@
+goulag_sort
+===========
+
+.. toctree::
+   :maxdepth: 4
+
+   goulagsort_package
--- a/requirements.txt
+++ b/requirements.txt
@ -0,0 +1,3 @@
+recommonmark~=0.7.1
+pytest~=8.3.5
+setuptools~=68.2.0