Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
WIP sagemath_doc_html sagemath_doc_pdf
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthias Koeppe committed Feb 7, 2021
1 parent 13b4090 commit 42b7714
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 17 deletions.
27 changes: 10 additions & 17 deletions build/make/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -294,35 +294,28 @@ base: $(inst_patch) $(inst_pkgconf)
#
# $ ./sage --docbuild -H

# Building the documentation has many dependencies, because all
# documented modules are imported and because we use matplotlib to
# produce plots.
DOC_DEPENDENCIES = sagelib $(inst_sphinx) \
| $(SAGERUNTIME) $(inst_maxima) $(inst_networkx) $(inst_scipy) $(inst_sympy) \
$(inst_matplotlib) $(inst_pillow) $(inst_mathjax) $(inst_mpmath) \
$(inst_ipykernel) $(inst_jupyter_client) $(inst_conway_polynomials) \
$(inst_tachyon) $(inst_jmol) $(inst_thebe) $(inst_ipywidgets)

doc: doc-html

doc-html: $(DOC_DEPENDENCIES)
$(AM_V_at)cd ../.. && sage-logger -p './sage --docbuild --no-pdf-links all html $(SAGE_DOCBUILD_OPTS)' logs/dochtml.log
# All doc-building is delegated to the script packages
# sagemath_doc_html, sagemath_doc_pdf
doc-html: sagemath_doc_html

# 'doc-html-no-plot': build docs without building the graphics coming
# from the '.. plot' directive, in case you want to save a few
# megabytes of disk space. 'doc-clean' is a prerequisite because the
# presence of graphics is cached in src/doc/output.
doc-html-no-plot: doc-clean $(DOC_DEPENDENCIES)
$(AM_V_at)cd ../.. && sage-logger -p './sage --docbuild --no-pdf-links --no-plot all html $(SAGE_DOCBUILD_OPTS)' logs/dochtml.log
doc-html-no-plot: doc-clean
+$(MAKE_REC) SAGE_SKIP_PLOT_DIRECTIVE=yes doc-html

doc-html-mathjax: $(DOC_DEPENDENCIES)
$(AM_V_at)cd ../.. && sage-logger -p './sage --docbuild --no-pdf-links all html -j $(SAGE_DOCBUILD_OPTS)' logs/dochtml.log
# Using mathjax is actually the default, but this target can be used
# to override an environment setting of SAGE_DOC_MATHJAX=no
doc-html-mathjax:
+$(MAKE_REC) SAGE_DOC_MATHJAX=yes doc-html

# Keep target 'doc-html-jsmath' for backwards compatibility.
doc-html-jsmath: doc-html-mathjax

doc-pdf: $(DOC_DEPENDENCIES)
$(AM_V_at)cd ../.. && sage-logger -p './sage --docbuild all pdf $(SAGE_DOCBUILD_OPTS)' logs/docpdf.log
doc-pdf: sagemath_doc_pdf

doc-clean: doc-src-clean doc-output-clean

Expand Down
5 changes: 5 additions & 0 deletions build/pkgs/sagemath_doc_html/dependencies
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
sagelib sphinx | $(SAGERUNTIME) maxima networkx scipy sympy matplotlib pillow mathjax mpmath ipykernel jupyter_client conway_polynomials tachyon jmol thebe ipywidgets

# Building the documentation has many dependencies, because all
# documented modules are imported and because we use matplotlib to
# produce plots.
3 changes: 3 additions & 0 deletions build/pkgs/sagemath_doc_html/spkg-install
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#! /usr/bin/env bash
cd $SAGE_ROOT
./sage --docbuild --no-pdf-links all html $SAGE_DOCBUILD_OPTS
1 change: 1 addition & 0 deletions build/pkgs/sagemath_doc_pdf/dependencies
3 changes: 3 additions & 0 deletions build/pkgs/sagemath_doc_pdf/spkg-install
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#! /usr/bin/env bash
cd $SAGE_ROOT
./sage --docbuild all pdf $SAGE_DOCBUILD_OPTS

0 comments on commit 42b7714

Please sign in to comment.