From 1c5e7539f251f802d1803d9bf2ecd8c8d4556452 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Thu, 26 Feb 2026 20:20:52 -0500 Subject: [PATCH] examples: rename to examples/article, to make room for others --- README.rst | 8 ++++---- examples/{ => article}/GNUmakefile | 10 +++++----- examples/{examples.tex => article/article.tex} | 2 +- examples/{ => article}/local-references.bib | 0 examples/{ => article}/sage-listings/example.listing | 0 5 files changed, 10 insertions(+), 10 deletions(-) rename examples/{ => article}/GNUmakefile (85%) rename examples/{examples.tex => article/article.tex} (99%) rename examples/{ => article}/local-references.bib (100%) rename examples/{ => article}/sage-listings/example.listing (100%) diff --git a/README.rst b/README.rst index 4c93247..5341bef 100644 --- a/README.rst +++ b/README.rst @@ -4,9 +4,9 @@ My personal library of LaTeX macros and operators Usage ===== -There is an example project in the ``examples`` directory that shows -you how to use the macros; the rest of this section is focused on -getting them usable. +There is an example project in the ``examples/article`` directory that +shows you how to use the macros; the rest of this section is focused +on getting them usable. Vanilla ------- @@ -42,7 +42,7 @@ from the one described in my `Makeing LaTeX `_ article. It is not meant to be invoked directly; instead, you should create your own ``GNUmakefile`` (in your own project) based on the one in -``examples/GNUmakefile``. This does several things: +``examples/article/GNUmakefile``. This does several things: #. Adds this repository to the TeX path. #. Declares a few relevant variables. diff --git a/examples/GNUmakefile b/examples/article/GNUmakefile similarity index 85% rename from examples/GNUmakefile rename to examples/article/GNUmakefile index 06db99b..4dc382f 100644 --- a/examples/GNUmakefile +++ b/examples/article/GNUmakefile @@ -8,18 +8,18 @@ # # * BIBS - BibTeX bibliography # * INDICES - the index, typically singular and named $(PN) -# * SAGE_LISTING_SRCS - testable sage code listings +# * SAGE_LISTINGS - testable sage code listings # * MJOTEX - macro source files from mjotex # # The repository has to be added to the TeX path, if this is not done # in ~/.bashrc or some equivalent place. -export TEXINPUTS := $(TEXINPUTS):../ -export BSTINPUTS := $(BSTINPUTS):../ +export TEXINPUTS := $(TEXINPUTS):../.. +export BSTINPUTS := $(BSTINPUTS):../.. # The name of the document. Defaults to name of the parent directory -# which in this case is also "examples", but is usually required. -PN = examples +# (which in this case is also "article"), but is usually required. +PN = article # Specify the remaining variables only if you use them. BIBS = local-references.bib diff --git a/examples/examples.tex b/examples/article/article.tex similarity index 99% rename from examples/examples.tex rename to examples/article/article.tex index 0e6191d..7c44442 100644 --- a/examples/examples.tex +++ b/examples/article/article.tex @@ -285,7 +285,7 @@ However, the smart way to display a SageMath listing is to load it from an external file (under the ``listings'' subdirectory): - \sagelisting{example} + \sagelisting{sage-listings/example} Keeping the listings in separate files makes it easy for the build system to test them. diff --git a/examples/local-references.bib b/examples/article/local-references.bib similarity index 100% rename from examples/local-references.bib rename to examples/article/local-references.bib diff --git a/examples/sage-listings/example.listing b/examples/article/sage-listings/example.listing similarity index 100% rename from examples/sage-listings/example.listing rename to examples/article/sage-listings/example.listing -- 2.51.0