Skip to content

Commit 464e8c3

Browse files
author
Release Manager
committed
Trac #33104: Fix references to doc-clean
Followup to #29310: `make doc-uninstall` should frequently be used instead of or in addition to `make doc-clean`, so the instructions for installation from source need to be fixed, as should error messages when building the docs. URL: https://trac.sagemath.org/33104 Reported by: jhpalmieri Ticket author(s): John Palmieri Reviewer(s): Matthias Koeppe
2 parents 22001aa + 2879f6d commit 464e8c3

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

build/pkgs/configure/checksums.ini

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
tarball=configure-VERSION.tar.gz
2-
sha1=63a185e63945337d9e35c8befb0842a338f8d485
3-
md5=d1ad922ab9d630f1f3d05ea2cd265a0d
4-
cksum=727308674
2+
sha1=9f326bb5728854f7621afaff496f491d0e1df5aa
3+
md5=ec6ced9c4e5241d7ee78f6082dc4b07a
4+
cksum=2674638119
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
866a2b24b7ffc1f489c181243c6b90659f79e741
1+
7c5ddd97148ade288dd7f8e8654aa8393f843004

src/doc/en/installation/source.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -936,7 +936,7 @@ how it is built:
936936
plots, adding about 4M to the :file:`local/share/doc/sage/` directory.
937937
In the future, this may grow, of course. Note: after using this, if you
938938
want to build the documentation and include the pictures, you should
939-
run ``make doc-clean``, because the presence, or lack, of pictures
939+
run ``make doc-uninstall``, because the presence, or lack, of pictures
940940
is cached in the documentation output.
941941
You can benefit from this no-plot feature with other make targets by doing
942942
``export SAGE_DOCBUILD_OPTS+=' --no-plot'``
@@ -952,8 +952,8 @@ how it is built:
952952
software, you can use ``make testall``, ``make ptestall``,
953953
``make testalllong``, or ``make ptestalllong``.
954954

955-
- ``make doc-clean`` removes several directories which are produced
956-
when building the documentation.
955+
- ``make doc-uninstall`` and ``make doc-clean`` each remove several
956+
directories which are produced when building the documentation.
957957

958958
- ``make distclean`` restores the Sage directory to its state before doing any
959959
building: it is almost equivalent to deleting Sage's entire home directory and

src/sage_docbuild/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1732,7 +1732,7 @@ def excepthook(*exc_info):
17321732
logger.error('''
17331733
Note: incremental documentation builds sometimes cause spurious
17341734
error messages. To be certain that these are real errors, run
1735-
"make doc-clean" first and try again.''')
1735+
"make doc-clean doc-uninstall" first and try again.''')
17361736

17371737
sys.excepthook = excepthook
17381738

0 commit comments

Comments
 (0)