From 91c289dc52c2c2f225a4e60775a4fce5a7789111 Mon Sep 17 00:00:00 2001 From: Olivia Appleton Date: Thu, 4 Jul 2024 22:54:03 -0500 Subject: [PATCH] attempt makefile docs --- docs/conf.py | 1 + docs/index.rst | 19 +++++++++++++++++++ docs/requirements.txt | 3 +-- docs/rust/p0001.rst | 2 +- 4 files changed, 22 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 7b984b3e..691b6a5b 100644 --- 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 index c4c7630d..9bb7359c 100644 --- 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 index d6de82c0..451e7377 100644 --- 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 index 8368663b..05aa64a4 100644 --- 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! `_ -.. rust:function:: rust::p0001::p0001 +.. rust:function:: p0001::p0001 .. literalinclude:: ../../rust/src/p0001.rs :language: rust