attempt makefile docs

LivInTheLookingGlass · Jul 5, 2024 · 91c289d · 91c289d
1 parent 2f1ad11
commit 91c289d
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -36,6 +36,7 @@
     # 'sphinx_autodoc_typehints',
     # 'sphinx_pyreverse',
     'sphinx_csharp.csharp',
+    'sphinxcontrib.makedomain',
 ]
 if 'TERMUX_VERSION' not in os.environ:
     # extensions.append('hawkmoth')

diff --git a/docs/index.rst b/docs/index.rst
@@ -15,6 +15,25 @@ This repo includes solutions in the following languages:
 .. include:: ../README.rst
     :start-after: If you are working on Project Euler problems, DO NOT use this as a source
 
+Usage
+-----
+
+This project is divided into several Makefiles, connected by a root Makefile which redirects commands whever necessary.
+
+.. highlight:: make
+
+.. make:target:: cs%
+
+.. make:target:: c%
+
+.. make:target:: js%
+
+.. make:target:: py%
+
+.. make:target:: rs%
+
+.. make:target:: %
+
 .. toctree::
    :maxdepth: 2
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -4,5 +4,4 @@ sphinx-js
 hawkmoth
 clang==14
 sphinx-csharp
-sphinx-rust
-
+sphinxcontrib-makedomain
diff --git a/docs/rust/p0001.rst b/docs/rust/p0001.rst
@@ -3,7 +3,7 @@ Rust Implementation of Problem 1
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/rust/src/p0001.rs>`_
 
-.. rust:function:: rust::p0001::p0001
+.. rust:function:: p0001::p0001
 
 .. literalinclude:: ../../rust/src/p0001.rs
    :language: rust