Merge pull request #532 from iKostanOrg/Documentation

Merge pull request #531 from iKostanOrg/master
iKostanOrg · Nov 23, 2024 · 0a0b325 · 0a0b325
2 parents 74c59ee + 7e5eedf
commit 0a0b325
Show file tree

Hide file tree

Showing 33 changed files with 64 additions and 32 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,8 +11,8 @@ Welcome to Python3 solutions for codewars problems's documentation!
    :caption: Contents:
 
    readme
-   kyu_2
-   kyu_3
+   kyu_2/kyu_2
+   kyu_3/kyu_3
    kyu_4
    kyu_5
    kyu_6

diff --git a/docs/kyu_2.evaluate_mathematical_expression.readme.rst b/docs/kyu_2.evaluate_mathematical_expression.readme.rst
diff --git a/...aluate_mathematical_expression.module.rst → ...aluate_mathematical_expression.module.rst b/...aluate_mathematical_expression.module.rst → ...aluate_mathematical_expression.module.rst
diff --git a/docs/kyu_2/kyu_2.evaluate_mathematical_expression.readme.rst b/docs/kyu_2/kyu_2.evaluate_mathematical_expression.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../../kyu_2/evaluate_mathematical_expression/README.md
+   :parser: myst_parser.sphinx_
diff --git a/...yu_2.evaluate_mathematical_expression.rst → ...yu_2.evaluate_mathematical_expression.rst b/...yu_2.evaluate_mathematical_expression.rst → ...yu_2.evaluate_mathematical_expression.rst
diff --git a/docs/kyu_2.readme.rst → docs/kyu_2/kyu_2.readme.rst b/docs/kyu_2.readme.rst → docs/kyu_2/kyu_2.readme.rst
@@ -1,5 +1,5 @@
 README
 ======
 
-.. include:: ../kyu_2/README.md
+.. include:: ../../kyu_2/README.md
    :parser: myst_parser.sphinx_
diff --git a/docs/kyu_2.rst → docs/kyu_2/kyu_2.rst b/docs/kyu_2.rst → docs/kyu_2/kyu_2.rst
diff --git a/docs/kyu_3.battleship_field_validator.readme.rst b/docs/kyu_3.battleship_field_validator.readme.rst
diff --git a/docs/kyu_3.line_safari_is_that_a_line.readme.rst b/docs/kyu_3.line_safari_is_that_a_line.readme.rst
diff --git a/docs/kyu_3.make_spiral.readme.rst b/docs/kyu_3.make_spiral.readme.rst
diff --git a/docs/kyu_3.rail_fence_cipher_encoding_and_decoding.readme.rst b/docs/kyu_3.rail_fence_cipher_encoding_and_decoding.readme.rst
diff --git a/...u_3.battleship_field_validator.module.rst → ...u_3.battleship_field_validator.module.rst b/...u_3.battleship_field_validator.module.rst → ...u_3.battleship_field_validator.module.rst
diff --git a/docs/kyu_3/kyu_3.battleship_field_validator.readme.rst b/docs/kyu_3/kyu_3.battleship_field_validator.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../../kyu_3/battleship_field_validator/README.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/kyu_3.battleship_field_validator.rst → ...yu_3/kyu_3.battleship_field_validator.rst b/docs/kyu_3.battleship_field_validator.rst → ...yu_3/kyu_3.battleship_field_validator.rst
diff --git a/docs/kyu_3.calculator.module.rst → docs/kyu_3/kyu_3.calculator.module.rst b/docs/kyu_3.calculator.module.rst → docs/kyu_3/kyu_3.calculator.module.rst
diff --git a/docs/kyu_3.calculator.readme.rst → docs/kyu_3/kyu_3.calculator.readme.rst b/docs/kyu_3.calculator.readme.rst → docs/kyu_3/kyu_3.calculator.readme.rst
@@ -1,5 +1,5 @@
 README
 ======
 
-.. include:: ../kyu_3/calculator/README.md
+.. include:: ../../kyu_3/calculator/README.md
    :parser: myst_parser.sphinx_
diff --git a/docs/kyu_3.calculator.rst → docs/kyu_3/kyu_3.calculator.rst b/docs/kyu_3.calculator.rst → docs/kyu_3/kyu_3.calculator.rst
diff --git a/...u_3.line_safari_is_that_a_line.module.rst → ...u_3.line_safari_is_that_a_line.module.rst b/...u_3.line_safari_is_that_a_line.module.rst → ...u_3.line_safari_is_that_a_line.module.rst
diff --git a/docs/kyu_3/kyu_3.line_safari_is_that_a_line.readme.rst b/docs/kyu_3/kyu_3.line_safari_is_that_a_line.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../../kyu_3/line_safari_is_that_a_line/README.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/kyu_3.line_safari_is_that_a_line.rst → ...yu_3/kyu_3.line_safari_is_that_a_line.rst b/docs/kyu_3.line_safari_is_that_a_line.rst → ...yu_3/kyu_3.line_safari_is_that_a_line.rst
diff --git a/docs/kyu_3.make_spiral.module.rst → docs/kyu_3/kyu_3.make_spiral.module.rst b/docs/kyu_3.make_spiral.module.rst → docs/kyu_3/kyu_3.make_spiral.module.rst
diff --git a/docs/kyu_3/kyu_3.make_spiral.readme.rst b/docs/kyu_3/kyu_3.make_spiral.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../../kyu_3/make_spiral/README.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/kyu_3.make_spiral.rst → docs/kyu_3/kyu_3.make_spiral.rst b/docs/kyu_3.make_spiral.rst → docs/kyu_3/kyu_3.make_spiral.rst
diff --git a/...e_cipher_encoding_and_decoding.module.rst → ...e_cipher_encoding_and_decoding.module.rst b/...e_cipher_encoding_and_decoding.module.rst → ...e_cipher_encoding_and_decoding.module.rst
diff --git a/docs/kyu_3/kyu_3.rail_fence_cipher_encoding_and_decoding.readme.rst b/docs/kyu_3/kyu_3.rail_fence_cipher_encoding_and_decoding.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../../kyu_3/rail_fence_cipher_encoding_and_decoding/README.md
+   :parser: myst_parser.sphinx_
diff --git a/...il_fence_cipher_encoding_and_decoding.rst → ...il_fence_cipher_encoding_and_decoding.rst b/...il_fence_cipher_encoding_and_decoding.rst → ...il_fence_cipher_encoding_and_decoding.rst
diff --git a/docs/kyu_3.readme.rst → docs/kyu_3/kyu_3.readme.rst b/docs/kyu_3.readme.rst → docs/kyu_3/kyu_3.readme.rst
@@ -1,5 +1,5 @@
 README
 ======
 
-.. include:: ../kyu_3/README.md
+.. include:: ../../kyu_3/README.md
    :parser: myst_parser.sphinx_
diff --git a/docs/kyu_3.rst → docs/kyu_3/kyu_3.rst b/docs/kyu_3.rst → docs/kyu_3/kyu_3.rst
diff --git a/docs/kyu_5.alphabet_wars_nuclear_strike.module.rst b/docs/kyu_5.alphabet_wars_nuclear_strike.module.rst
@@ -0,0 +1,11 @@
+kyu\_5.alphabet\_wars\_nuclear\_strike.module module
+====================================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   kyu_5.alphabet_wars_nuclear_strike.readme
+   kyu_5.alphabet_wars_nuclear_strike
diff --git a/docs/kyu_5.alphabet_wars_nuclear_strike.readme.rst b/docs/kyu_5.alphabet_wars_nuclear_strike.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../kyu_5/alphabet_wars_nuclear_strike/README.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/kyu_5.count_ip_addresses.module.rst b/docs/kyu_5.count_ip_addresses.module.rst
@@ -0,0 +1,11 @@
+kyu\_5.count\_ip\_addresses.module module
+=========================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   kyu_5.count_ip_addresses.readme
+   kyu_5.count_ip_addresses
diff --git a/docs/kyu_5.count_ip_addresses.readme.rst b/docs/kyu_5.count_ip_addresses.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../kyu_5/count_ip_addresses/README.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/kyu_5.rst b/docs/kyu_5.rst
@@ -8,8 +8,8 @@ Subpackages
    :maxdepth: 4
 
    kyu_5.readme
-   kyu_5.alphabet_wars_nuclear_strike
-   kyu_5.count_ip_addresses
+   kyu_5.alphabet_wars_nuclear_strike.module
+   kyu_5.count_ip_addresses.module
    kyu_5.did_i_finish_my_sudoku
    kyu_5.diophantine_equation
    kyu_5.directions_reduction
-Original file line number
+Diff line change
@@ Expand Up @@
        :caption: Contents:
        readme
-       kyu_2
-       kyu_3
+       kyu_2/kyu_2
+       kyu_3/kyu_3
        kyu_4
        kyu_5
        kyu_6
@@ Expand Down @@