Skip to content

Commit 161a7e7

Browse files
author
Matthias Koeppe
committed
src/doc/en/installation/source.rst (SAGE_DOCBUILD_OPTS): Mention --no-preparsed-examples
1 parent 6412ce4 commit 161a7e7

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

src/doc/en/installation/source.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -940,11 +940,19 @@ Environment variables controlling the documentation build
940940

941941
The value of this variable is passed as an
942942
argument to ``sage --docbuild all html`` or ``sage --docbuild all pdf`` when
943-
you run ``make``, ``make doc``, or ``make doc-pdf``. For example, you can
944-
add ``--no-plot`` to this variable to avoid building the graphics coming from
945-
the ``.. PLOT`` directive within the documentation, or you can add
946-
``--include-tests-blocks`` to include all "TESTS" blocks in the reference
947-
manual. Run ``sage --docbuild help`` to see the full list of options.
943+
you run ``make``, ``make doc``, or ``make doc-pdf``. For example:
944+
945+
- add ``--no-plot`` to this variable to avoid building the graphics coming from
946+
the ``.. PLOT`` directive within the documentation,
947+
948+
- add ``--no-preparsed-examples`` to only show the original Sage code of
949+
"EXAMPLES" blocks, suppressing the tab with the preparsed, plain Python
950+
version, or
951+
952+
- add ``--include-tests-blocks`` to include all "TESTS" blocks in the reference
953+
manual.
954+
955+
Run ``sage --docbuild help`` to see the full list of options.
948956

949957
.. envvar:: SAGE_SPKG_INSTALL_DOCS
950958

0 commit comments

Comments
 (0)