From 5eadda52f658321e4e59a2083c39f33b4d7d5b96 Mon Sep 17 00:00:00 2001 From: Olivia Appleton Date: Thu, 4 Jul 2024 23:18:01 -0500 Subject: [PATCH] More Makefile docs --- docs/index.rst | 49 ++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 46 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 9bb7359c..a30352ae 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,9 +12,6 @@ This repo includes solutions in the following languages: :start-line: 2 :end-before: This is the repository -.. include:: ../README.rst - :start-after: If you are working on Project Euler problems, DO NOT use this as a source - Usage ----- @@ -22,18 +19,64 @@ This project is divided into several Makefiles, connected by a root Makefile whi .. highlight:: make +.. make:var:: PY + + A string that contains the command used for your Python interpreter. Defaults to ``python3``. + +.. make:target:: clean + + Removes all temporary or cache files, as well as any build artifacts + +.. make:target:: html + + This recipe redirects to the docs Makefile. Note that this is actually a + multi-target recipe that includes any builder name supported by + ``Sphinx `_. + Only ``html`` has guaranteed support, but currently implemented are: + + - ``html`` + - ``dirhtml`` + - ``singlehtml`` + - ``epub`` + - ``latex`` + - ``man`` + - ``htmlhelp`` + - ``qthelp`` + - ``devhelp`` + - ``applehelp`` + - ``texinfo`` + - ``text`` + - ``gettext`` + - ``doctest`` + - ``linkcheck`` + - ``xml`` + - ``pseudoxml`` + .. make:target:: cs% + Recipes with this prefix are redirected to the C# directory. Please see language-specific documentation for more details. + .. make:target:: c% + Recipes with this prefix are redirected to the C directory. Please see language-specific documentation for more details. + .. make:target:: js% + Recipes with this prefix are redirected to the JavaScript directory. Please see language-specific documentation for more details. + .. make:target:: py% + Recipes with this prefix are redirected to the Python directory. Please see language-specific documentation for more details. + .. make:target:: rs% + Recipes with this prefix are redirected to the Rust directory. Please see language-specific documentation for more details. + .. make:target:: % + If the recipe you call isn't covered by any others, it will get distributed to all languages. So for instance, + ``make test`` would be translated to ``make cstest ctest jstest pytest rstest`` + .. toctree:: :maxdepth: 2