Skip to content

Commit 5661373

Browse files
billsacksfritzt
authored andcommitted
Remove near-duplicated Makefiles and conf.py files
Previously, we had been (sort of) supporting builds of just the User's Guide or just the Tech Note via near-duplicated copies of the Makefile and conf.py file. However, these didn't really seem to work right for an html build (the files ended up in the wrong directory structure), and this was going to be harder to support and maintain moving forward, because of the duplication. Erik Kluzek and Keith Oleson have confirmed that they don't actually need support for an html build of just part of the documentation. I have made changes to the main Makefile to support just building a pdf of the tech note (not including the User's Guide), which IS needed.
1 parent 6f711ef commit 5661373

File tree

5 files changed

+13
-403
lines changed

5 files changed

+13
-403
lines changed

doc/Makefile

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,19 @@ fetch-images:
2323

2424
.PHONY: help fetch-images Makefile
2525

26+
# For the pdf, we only build the tech note, but use the conf.py file in
27+
# the top-level source directory (the -c option says where to find
28+
# conf.py). Note that we also override the setting of
29+
# numfig_secnum_depth in order to have figure numbering as desired in
30+
# the pdf, given that the pdf just contains the tech note, so doesn't
31+
# have the top-level numbering present in the web documentation (where
32+
# top-level section 1 is the User's Guide and section 2 is the Tech
33+
# Note).
34+
#
35+
# The use of $(0) is as in the catch-all target.
36+
latexpdf:
37+
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)/tech_note" "$(BUILDDIR)" -c "$(SOURCEDIR)" -D numfig_secnum_depth=1 $(SPHINXOPTS) $(O)
38+
2639
# Catch-all target: route all unknown targets to Sphinx using the new
2740
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
2841
%: Makefile

doc/Makefile.tech_note

Lines changed: 0 additions & 29 deletions
This file was deleted.

doc/Makefile.users_guide

Lines changed: 0 additions & 29 deletions
This file was deleted.

doc/source/tech_note/conf.py

Lines changed: 0 additions & 171 deletions
This file was deleted.

0 commit comments

Comments
 (0)