From 3aa86298bb57850d62a6f0c3c139b04c20765080 Mon Sep 17 00:00:00 2001 From: Gustavo Henrique Santos Souza de Miranda Date: Tue, 20 May 2025 02:40:54 -0300 Subject: [PATCH] Added Documentation using Sphinx to the project --- docs/source/goulag_sort_detailed_explanation.rst | 4 ++++ docs/source/goulagsort_package.rst | 8 ++++++++ docs/source/modules.rst | 7 +++++++ requirements.txt | 3 +++ 4 files changed, 22 insertions(+) create mode 100644 docs/source/goulag_sort_detailed_explanation.rst create mode 100644 docs/source/goulagsort_package.rst create mode 100644 docs/source/modules.rst create mode 100644 requirements.txt diff --git a/docs/source/goulag_sort_detailed_explanation.rst b/docs/source/goulag_sort_detailed_explanation.rst new file mode 100644 index 0000000..98945a5 --- /dev/null +++ b/docs/source/goulag_sort_detailed_explanation.rst @@ -0,0 +1,4 @@ +.. _goulag_sort_detailed_explanation: + +Goulag Sort Explained +======================== \ No newline at end of file diff --git a/docs/source/goulagsort_package.rst b/docs/source/goulagsort_package.rst new file mode 100644 index 0000000..2e5c3b5 --- /dev/null +++ b/docs/source/goulagsort_package.rst @@ -0,0 +1,8 @@ +goulag_sort Package +=================== + +.. automodule:: goulag_sort + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..2b13c65 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +goulag_sort +=========== + +.. toctree:: + :maxdepth: 4 + + goulagsort_package diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..a7de4ad --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +recommonmark~=0.7.1 +pytest~=8.3.5 +setuptools~=68.2.0 \ No newline at end of file