Reorganize docs

LivInTheLookingGlass · Aug 15, 2024 · 6e6b391 · 6e6b391
1 parent 0ca9bcf
commit 6e6b391
Show file tree

Hide file tree

Showing 247 changed files with 470 additions and 501 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -134,11 +134,11 @@
     'live-test': ('/_static/test-%s.html',
                   'click here!%.0s'),
 } | {
-    f'{code}-d': (f'./{lang}/p%s.html', '✔%.0s') for (code, lang) in langcodes
+    f'{code}-d': (f'./src/{lang}/p%s.html', '✔%.0s') for (code, lang) in langcodes
 } | {
-    f'{code}-s': (f'./{lang}/p%s.html', '⏱%.0s') for (code, lang) in langcodes
+    f'{code}-s': (f'./src/{lang}/p%s.html', '⏱%.0s') for (code, lang) in langcodes
 } | {
-    f'{code}-i': (f'./{lang}/p%s.html', '🛠%.0s') for (code, lang) in langcodes
+    f'{code}-i': (f'./src/{lang}/p%s.html', '🛠%.0s') for (code, lang) in langcodes
 }
 extlinks_detect_hardcoded_links = True
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -73,7 +73,7 @@ Problems Solved
 +-----------+------------+------------+------------+------------+------------+------------+------------+
 | Testing   |    |d|     |    |d|     |    |d|     |    |d|     |    |d|     |    |d|     |    |d|     |
 +-----------+------------+------------+------------+------------+------------+------------+------------+
-| Browser   |            |            |            |            |    |d|     |    |d|     |    |ip|    |
+| Browser   |            |            |            |            |    |d|     |    |d|     |    |d|     |
 +-----------+------------+------------+------------+------------+------------+------------+------------+
 +-----------+------------+------------+------------+------------+------------+------------+------------+
 |:prob:`1`  |:c-d:`0001` |:cp-d:`0001`|:cs-d:`0001`|:ja-d:`0001`|:js-d:`0001`|:py-d:`0001`|:rs-d:`0001`|
@@ -236,16 +236,11 @@ Problems Solved
 +-----------+------------+------------+------------+------------+------------+------------+------------+
 
 .. toctree::
+   :glob:
    :maxdepth: 2
 
    usage
-   c
-   cplusplus
-   csharp
-   java
-   javascript
-   python
-   rust
+   src/*
 
 Indices and tables
 ==================

diff --git a/docs/rust/primes.rst b/docs/rust/primes.rst
diff --git a/docs/c.rst → docs/src/c.rst b/docs/c.rst → docs/src/c.rst
@@ -1,26 +1,19 @@
 Euler C Implementation
 ======================
 
-.. include:: ../c/README.rst
+.. include:: ../../c/README.rst
     :start-line: 2
     :end-before: Problems Solved
 
 Library Code
 ------------
 
 .. toctree::
+   :glob:
    :numbered:
    :maxdepth: 1
 
-   c/bcd
-   c/digits
-   c/factors
-   c/fibonacci
-   c/iterator
-   c/macros
-   c/math
-   c/primes
-   c/utils
+   c/lib/*
 
 Problems Solved
 ---------------

diff --git a/docs/c/bcd.rst → docs/src/c/lib/bcd.rst b/docs/c/bcd.rst → docs/src/c/lib/bcd.rst
@@ -114,6 +114,6 @@ It was also a good exercise in x86 assembly, as several portions are accellerate
 
 .. c:namespace-pop::
 
-.. literalinclude:: ../../c/src/include/bcd.h
+.. literalinclude:: ../../../../c/src/include/bcd.h
    :language: C
    :linenos:
diff --git a/docs/c/digits.rst → docs/src/c/lib/digits.rst b/docs/c/digits.rst → docs/src/c/lib/digits.rst
@@ -40,6 +40,6 @@ View source code :source:`c/src/include/digits.h`
 
 .. c:namespace-pop::
 
-.. literalinclude:: ../../c/src/include/digits.h
+.. literalinclude:: ../../../../c/src/include/digits.h
    :language: C
    :linenos:
diff --git a/docs/c/factors.rst → docs/src/c/lib/factors.rst b/docs/c/factors.rst → docs/src/c/lib/factors.rst
@@ -31,6 +31,6 @@ factors for a given number. It is generally used by first calling
 
 .. c:namespace-pop::
 
-.. literalinclude:: ../../c/src/include/factors.h
+.. literalinclude:: ../../../../c/src/include/factors.h
    :language: C
    :linenos:
diff --git a/docs/c/fibonacci.rst → docs/src/c/lib/fibonacci.rst b/docs/c/fibonacci.rst → docs/src/c/lib/fibonacci.rst
@@ -39,6 +39,6 @@ View source code :source:`c/src/include/fibonacci.h`
 
 .. c:namespace-pop::
 
-.. literalinclude:: ../../c/src/include/fibonacci.h
+.. literalinclude:: ../../../../c/src/include/fibonacci.h
    :language: C
    :linenos:
diff --git a/docs/c/iterator.rst → docs/src/c/lib/iterator.rst b/docs/c/iterator.rst → docs/src/c/lib/iterator.rst
@@ -102,6 +102,6 @@ View source code :source:`c/src/include/iterator.h`
 
 .. c:namespace-pop::
 
-.. literalinclude:: ../../c/src/include/iterator.h
+.. literalinclude:: ../../../../c/src/include/iterator.h
    :language: C
    :linenos:
diff --git a/docs/c/macros.rst → docs/src/c/lib/macros.rst b/docs/c/macros.rst → docs/src/c/lib/macros.rst
@@ -57,6 +57,6 @@ View source code :source:`c/src/include/macros.h`
 
 .. c:namespace-pop::
 
-.. literalinclude:: ../../c/src/include/macros.h
+.. literalinclude:: ../../../../c/src/include/macros.h
    :language: C
    :linenos:
diff --git a/docs/c/math.rst → docs/src/c/lib/math.rst b/docs/c/math.rst → docs/src/c/lib/math.rst
@@ -34,6 +34,6 @@ View source code :source:`c/src/include/math.h`
 
 .. c:namespace-pop::
 
-.. literalinclude:: ../../c/src/include/math.h
+.. literalinclude:: ../../../../c/src/include/math.h
    :language: C
    :linenos:
diff --git a/docs/c/primes.rst → docs/src/c/lib/primes.rst b/docs/c/primes.rst → docs/src/c/lib/primes.rst
@@ -136,6 +136,6 @@ View source code :source:`c/src/include/primes.h`
 
 .. c:namespace-pop::
 
-.. literalinclude:: ../../c/src/include/primes.h
+.. literalinclude:: ../../../../c/src/include/primes.h
    :language: C
    :linenos:
diff --git a/docs/c/utils.rst → docs/src/c/lib/utils.rst b/docs/c/utils.rst → docs/src/c/lib/utils.rst
@@ -13,6 +13,6 @@ View source code :source:`c/src/include/utils.h`
 
 .. c:namespace-pop::
 
-.. literalinclude:: ../../c/src/include/utils.h
+.. literalinclude:: ../../../../c/src/include/utils.h
    :language: C
    :linenos:
diff --git a/docs/c/p0001.rst → docs/src/c/p0001.rst b/docs/c/p0001.rst → docs/src/c/p0001.rst
@@ -6,7 +6,7 @@ View source code :source:`c/src/p0001.c`
 Includes
 --------
 
-- `iterator.h <./iterator.html>`__
+- `iterator.h <./lib/iterator.html>`__
 
 Solution
 --------
@@ -20,6 +20,6 @@ Solution
       This function is only present in the Python test runner, or when compiling as a standalone program.
       It is not present when compiling for the Unity test runner.
 
-.. literalinclude:: ../../c/src/p0001.c
+.. literalinclude:: ../../../c/src/p0001.c
    :language: C
    :linenos:
diff --git a/docs/c/p0002.rst → docs/src/c/p0002.rst b/docs/c/p0002.rst → docs/src/c/p0002.rst
@@ -6,7 +6,7 @@ View source code :source:`c/src/p0002.c`
 Includes
 --------
 
-- `fibonacci.h <./fibonacci.html>`__
+- `fibonacci.h <./lib/fibonacci.html>`__
 
 Solution
 --------
@@ -20,6 +20,6 @@ Solution
       This function is only present in the Python test runner, or when compiling as a standalone program.
       It is not present when compiling for the Unity test runner.
 
-.. literalinclude:: ../../c/src/p0002.c
+.. literalinclude:: ../../../c/src/p0002.c
    :language: C
    :linenos:
diff --git a/docs/c/p0003.rst → docs/src/c/p0003.rst b/docs/c/p0003.rst → docs/src/c/p0003.rst
@@ -6,7 +6,7 @@ View source code :source:`c/src/p0003.c`
 Includes
 --------
 
-- `primes.h <./primes.html>`__
+- `primes.h <./lib/primes.html>`__
 
 Solution
 --------
@@ -20,6 +20,6 @@ Solution
       This function is only present in the Python test runner, or when compiling as a standalone program.
       It is not present when compiling for the Unity test runner.
 
-.. literalinclude:: ../../c/src/p0003.c
+.. literalinclude:: ../../../c/src/p0003.c
    :language: C
    :linenos:
diff --git a/docs/c/p0004.rst → docs/src/c/p0004.rst b/docs/c/p0004.rst → docs/src/c/p0004.rst
@@ -6,7 +6,7 @@ View source code :source:`c/src/p0004.c`
 Includes
 --------
 
-- `iterator.h <./digits.html>`__
+- `iterator.h <./lib/digits.html>`__
 
 Solution
 --------
@@ -20,6 +20,6 @@ Solution
       This function is only present in the Python test runner, or when compiling as a standalone program.
       It is not present when compiling for the Unity test runner.
 
-.. literalinclude:: ../../c/src/p0004.c
+.. literalinclude:: ../../../c/src/p0004.c
    :language: C
    :linenos:
diff --git a/docs/c/p0005.rst → docs/src/c/p0005.rst b/docs/c/p0005.rst → docs/src/c/p0005.rst
@@ -6,8 +6,8 @@ View source code :source:`c/src/p0005.c`
 Includes
 --------
 
-- `macros.h <./macros.html>`__
-- `primes.h <./primes.html>`__
+- `macros.h <./lib/macros.html>`__
+- `primes.h <./lib/primes.html>`__
 
 Solution
 --------
@@ -21,6 +21,6 @@ Solution
       This function is only present in the Python test runner, or when compiling as a standalone program.
       It is not present when compiling for the Unity test runner.
 
-.. literalinclude:: ../../c/src/p0005.c
+.. literalinclude:: ../../../c/src/p0005.c
    :language: C
    :linenos:
diff --git a/docs/c/p0006.rst → docs/src/c/p0006.rst b/docs/c/p0006.rst → docs/src/c/p0006.rst
@@ -15,6 +15,6 @@ Solution
       This function is only present in the Python test runner, or when compiling as a standalone program.
       It is not present when compiling for the Unity test runner.
 
-.. literalinclude:: ../../c/src/p0006.c
+.. literalinclude:: ../../../c/src/p0006.c
    :language: C
    :linenos:
diff --git a/docs/c/p0007.rst → docs/src/c/p0007.rst b/docs/c/p0007.rst → docs/src/c/p0007.rst
@@ -6,7 +6,7 @@ View source code :source:`c/src/p0007.c`
 Includes
 --------
 
-- `primes.h <./primes.html>`__
+- `primes.h <./lib/primes.html>`__
 
 Solution
 --------
@@ -20,6 +20,6 @@ Solution
       This function is only present in the Python test runner, or when compiling as a standalone program.
       It is not present when compiling for the Unity test runner.
 
-.. literalinclude:: ../../c/src/p0007.c
+.. literalinclude:: ../../../c/src/p0007.c
    :language: C
    :linenos:
diff --git a/docs/c/p0008.rst → docs/src/c/p0008.rst b/docs/c/p0008.rst → docs/src/c/p0008.rst
@@ -6,7 +6,7 @@ View source code :source:`c/src/p0008.c`
 Includes
 --------
 
-- `macros.h <./macros.html>`__
+- `macros.h <./lib/macros.html>`__
 
 Solution
 --------
@@ -20,6 +20,6 @@ Solution
       This function is only present in the Python test runner, or when compiling as a standalone program.
       It is not present when compiling for the Unity test runner.
 
-.. literalinclude:: ../../c/src/p0008.c
+.. literalinclude:: ../../../c/src/p0008.c
    :language: C
    :linenos:
diff --git a/docs/c/p0009.rst → docs/src/c/p0009.rst b/docs/c/p0009.rst → docs/src/c/p0009.rst
@@ -15,6 +15,6 @@ Solution
       This function is only present in the Python test runner, or when compiling as a standalone program.
       It is not present when compiling for the Unity test runner.
 
-.. literalinclude:: ../../c/src/p0009.c
+.. literalinclude:: ../../../c/src/p0009.c
    :language: C
    :linenos:
diff --git a/docs/c/p0010.rst → docs/src/c/p0010.rst b/docs/c/p0010.rst → docs/src/c/p0010.rst
@@ -6,7 +6,7 @@ View source code :source:`c/src/p0010.c`
 Includes
 --------
 
-- `primes.h <./primes.html>`__
+- `primes.h <./lib/primes.html>`__
 
 Solution
 --------
@@ -20,6 +20,6 @@ Solution
       This function is only present in the Python test runner, or when compiling as a standalone program.
       It is not present when compiling for the Unity test runner.
 
-.. literalinclude:: ../../c/src/p0010.c
+.. literalinclude:: ../../../c/src/p0010.c
    :language: C
    :linenos:
diff --git a/docs/c/p0011.rst → docs/src/c/p0011.rst b/docs/c/p0011.rst → docs/src/c/p0011.rst
@@ -6,7 +6,7 @@ View source code :source:`c/src/p0011.c`
 Includes
 --------
 
-- `macros.h <./macros.html>`__
+- `macros.h <./lib/macros.html>`__
 
 Solution
 --------
@@ -20,6 +20,6 @@ Solution
       This function is only present in the Python test runner, or when compiling as a standalone program.
       It is not present when compiling for the Unity test runner.
 
-.. literalinclude:: ../../c/src/p0011.c
+.. literalinclude:: ../../../c/src/p0011.c
    :language: C
    :linenos:
diff --git a/docs/c/p0012.rst → docs/src/c/p0012.rst b/docs/c/p0012.rst → docs/src/c/p0012.rst
@@ -11,7 +11,7 @@ View source code :source:`c/src/p0012.c`
 Includes
 --------
 
-- `factors.h <./factors.html>`__
+- `factors.h <./lib/factors.html>`__
 
 Solution
 --------
@@ -25,6 +25,6 @@ Solution
       This function is only present in the Python test runner, or when compiling as a standalone program.
       It is not present when compiling for the Unity test runner.
 
-.. literalinclude:: ../../c/src/p0012.c
+.. literalinclude:: ../../../c/src/p0012.c
    :language: C
    :linenos: