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

Commit

Permalink
Merge remote-tracking branch 'origin/public/25833' into public/doctes…
Browse files Browse the repository at this point in the history
…ts/furo
  • Loading branch information
tobiasdiez committed May 2, 2022
2 parents 3bf8620 + 2535a91 commit 80e39a1
Show file tree
Hide file tree
Showing 88 changed files with 3,396 additions and 2,188 deletions.
7 changes: 6 additions & 1 deletion build/pkgs/mathjax/SPKG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Description

MathJax is a JavaScript library for displaying mathematical formulas.

MathJax is used by the Sage documentation built by Sphinx.
MathJax is used in the Sage documentation built by Sphinx.

License
-------
Expand All @@ -30,3 +30,8 @@ Special Update/Build Instructions

None


Patches
-------

None.
1 change: 1 addition & 0 deletions build/pkgs/mathjax/checksums.ini
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ tarball=mathjax-VERSION.tar.gz
sha1=3f7abecf8cacd7f5d7f9ae6c3baca7739101c17d
md5=ba1a65ab58aaad6c84f39735c619bc34
cksum=1142131398
upstream_url=https://trac.sagemath.org/raw-attachment/ticket/25833/mathjax-3.2.0.tar.gz
44 changes: 5 additions & 39 deletions build/pkgs/mathjax/spkg-src
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ set -e

[ -n "${SAGE_ROOT}" ] || SAGE_ROOT="$(pwd)/../../../"

# Determine the latest version
# determine the latest version
GIT_VERSION="$(curl https://github.com/mathjax/MathJax/releases | grep 'MathJax v' | head -1 | sed 's|^.*MathJax v||g' | sed 's/\s*$//g')"
echo "GIT_VERSION=$GIT_VERSION"

# Fetch and rename the latest version
# fetch and rename the latest version
URL="https://github.com/mathjax/MathJax/archive/refs/tags/${GIT_VERSION}.zip"
echo "Downloading $URL"
rm -rf src
Expand All @@ -18,51 +18,17 @@ else
tar xzf "$UPSTREAM_SOURCE_TARBALL"
fi

# Put files under mathjax directory
# put files under mathjax directory
mkdir src
mv MathJax-${GIT_VERSION}/es5 src/mathjax
rm -r MathJax-${GIT_VERSION}


# The following block of commented-out lines were used to reduce the package
# size of MathJax2. We keep these lines for the future when we will want to
# reuse and rewrite them to remove unnecessary font files from MathJax3.

## Trimming I -- removing files unnecessary for deployment
#FILEDIRS_TO_REMOVE='docs/ test/ unpacked/ .gitignore README-branch.txt README.md bower.json'
#for filedir in ${FILEDIRS_TO_REMOVE} ; do
# rm -rf "src/${filedir}"
#done
#
## Trimming II -- not strictly necessary (requires the patch nopng_config.patch)
#rm -rf 'src/fonts/HTML-CSS/TeX/png/'
#
## Trimming III -- fonts
#FONTS_TO_REMOVE='Asana-Math Gyre-Pagella Gyre-Termes Latin-Modern Neo-Euler'
#for font in ${FONTS_TO_REMOVE} ; do
# find . -type d -name "${font}" -prune -exec rm -rf {} \;
#done
#
#FONT_FORMATS_TO_REMOVE='eot otf svg'
#for fontformat in ${FONT_FORMATS_TO_REMOVE} ; do
# find . -type d -name "${fontformat}" -prune -exec rm -rf {} \;
#done
#
## Trimming IV -- reducing input and output options
#OUTPUT_OPTIONS_TO_REMOVE='NativeMML SVG'
#for output in ${OUTPUT_OPTIONS_TO_REMOVE} ; do
# rm -rf "src/jax/output/${output}"
#done


PACKAGE_VERSION=${GIT_VERSION}

# Repackage.
# repackage
tar czf "$SAGE_ROOT/upstream/mathjax-${PACKAGE_VERSION}.tar.gz" src
rm -rf src

# Update package info
# update package info
echo "${PACKAGE_VERSION}" > 'package-version.txt'
"$SAGE_ROOT"/sage --package fix-checksum mathjax


2 changes: 1 addition & 1 deletion pkgs/sagemath-objects/MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ include sage/misc/flatten.* # dep of sage/categories/coxeter_groups.

include sage/misc/lazy_import*.*
include sage/misc/sageinspect.* # dep of sage/misc/lazy_import
graft sage/docs # dep of sage/misc/lazy_import
include sage/misc/instancedoc.* # dep of sage/misc/lazy_import

include sage/misc/persist.*
include sage/misc/sage_unittest.* # dep of sage/misc/persist
Expand Down
6 changes: 3 additions & 3 deletions src/doc/ca/intro/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

from sage.docs.conf import release
from sage.docs.conf import * # NOQA
from sage_docbuild.conf import release
from sage_docbuild.conf import * # NOQA

# Add any paths that contain custom static files (such as style sheets),
# relative to this directory to html_static_path. They are copied after the
# builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css". html_common_static_path imported from sage.docs.conf
# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
# contains common paths.
html_static_path = [] + html_common_static_path

Expand Down
6 changes: 3 additions & 3 deletions src/doc/de/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

from sage.docs.conf import release
from sage.docs.conf import * # NOQA
from sage_docbuild.conf import release
from sage_docbuild.conf import * # NOQA

# Add any paths that contain custom static files (such as style sheets),
# relative to this directory to html_static_path. They are copied after the
# builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css". html_common_static_path imported from sage.docs.conf
# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
# contains common paths.
html_static_path = [] + html_common_static_path

Expand Down
6 changes: 3 additions & 3 deletions src/doc/de/thematische_anleitungen/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

from sage.docs.conf import release
from sage.docs.conf import * # NOQA
from sage_docbuild.conf import release
from sage_docbuild.conf import * # NOQA

# Add any paths that contain custom static files (such as style sheets),
# relative to this directory to html_static_path. They are copied after the
# builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css". html_common_static_path imported from sage.docs.conf
# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
# contains common paths.
html_static_path = [] + html_common_static_path

Expand Down
6 changes: 3 additions & 3 deletions src/doc/de/tutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

from sage.docs.conf import release
from sage.docs.conf import * # NOQA
from sage_docbuild.conf import release
from sage_docbuild.conf import * # NOQA

# Add any paths that contain custom static files (such as style sheets),
# relative to this directory to html_static_path. They are copied after the
# builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css". html_common_static_path imported from sage.docs.conf
# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
# contains common paths.
html_static_path = [] + html_common_static_path

Expand Down
6 changes: 3 additions & 3 deletions src/doc/en/a_tour_of_sage/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

from sage.docs.conf import release
from sage.docs.conf import * # NOQA
from sage_docbuild.conf import release
from sage_docbuild.conf import * # NOQA

# Add any paths that contain custom static files (such as style sheets),
# relative to this directory to html_static_path. They are copied after the
# builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css". html_common_static_path imported from sage.docs.conf
# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
# contains common paths.
html_static_path = [] + html_common_static_path

Expand Down
6 changes: 3 additions & 3 deletions src/doc/en/constructions/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

from sage.docs.conf import release
from sage.docs.conf import * # NOQA
from sage_docbuild.conf import release
from sage_docbuild.conf import * # NOQA

# Add any paths that contain custom static files (such as style sheets),
# relative to this directory to html_static_path. They are copied after the
# builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css". html_common_static_path imported from sage.docs.conf
# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
# contains common paths.
html_static_path = [] + html_common_static_path

Expand Down
6 changes: 3 additions & 3 deletions src/doc/en/developer/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

from sage.docs.conf import release
from sage.docs.conf import * # NOQA
from sage_docbuild.conf import release
from sage_docbuild.conf import * # NOQA

# Add any paths that contain custom static files (such as style sheets),
# relative to this directory to html_static_path. They are copied after the
# builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css". html_common_static_path imported from sage.docs.conf
# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
# contains common paths.
html_static_path = [] + html_common_static_path

Expand Down
6 changes: 3 additions & 3 deletions src/doc/en/faq/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

from sage.docs.conf import release
from sage.docs.conf import *
from sage_docbuild.conf import release
from sage_docbuild.conf import *

# Add any paths that contain custom static files (such as style sheets),
# relative to this directory to html_static_path. They are copied after the
# builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css". html_common_static_path imported from sage.docs.conf
# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
# contains common paths.
html_static_path = [] + html_common_static_path

Expand Down
6 changes: 3 additions & 3 deletions src/doc/en/installation/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

from sage.docs.conf import release
from sage.docs.conf import * # NOQA
from sage_docbuild.conf import release
from sage_docbuild.conf import * # NOQA

# Add any paths that contain custom static files (such as style sheets),
# relative to this directory to html_static_path. They are copied after the
# builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css". html_common_static_path imported from sage.docs.conf
# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
# contains common paths.
html_static_path = [] + html_common_static_path

Expand Down
6 changes: 3 additions & 3 deletions src/doc/en/prep/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

from sage.docs.conf import release
from sage.docs.conf import * # NOQA
from sage_docbuild.conf import release
from sage_docbuild.conf import * # NOQA

# Add any paths that contain custom static files (such as style sheets),
# relative to this directory to html_static_path. They are copied after the
# builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css". html_common_static_path imported from sage.docs.conf
# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
# contains common paths.
html_static_path = [] + html_common_static_path

Expand Down
6 changes: 3 additions & 3 deletions src/doc/en/reference/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@

import os
from sage.env import SAGE_DOC_SRC, SAGE_DOC
from sage.docs.conf import release, latex_elements, exclude_patterns
from sage.docs.conf import *
from sage_docbuild.conf import release, latex_elements, exclude_patterns
from sage_docbuild.conf import *

# Add any paths that contain custom static files (such as style sheets),
# relative to this directory to html_static_path. They are copied after the
# builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css". html_common_static_path imported from sage.docs.conf
# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
# contains common paths.
html_static_path = [] + html_common_static_path

Expand Down
6 changes: 3 additions & 3 deletions src/doc/en/reference/conf_sub.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@

import os
from sage.env import SAGE_DOC_SRC, SAGE_DOC
from sage.docs.conf import release, exclude_patterns
from sage.docs.conf import *
from sage_docbuild.conf import release, exclude_patterns
from sage_docbuild.conf import *

# Add any paths that contain custom static files (such as style sheets),
# relative to this directory to html_static_path. They are copied after the
# builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css". html_common_static_path imported from sage.docs.conf
# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
# contains common paths.
html_static_path = [] + html_common_static_path

Expand Down
1 change: 1 addition & 0 deletions src/doc/en/reference/documentation/conf.py
12 changes: 12 additions & 0 deletions src/doc/en/reference/documentation/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Documentation System
====================

.. toctree::
:maxdepth: 1

sage_docbuild/__main__
sage_docbuild/builders
sage_docbuild/build_options
sage_docbuild/sphinxbuild
sage_docbuild/conf
sage_docbuild/utils
8 changes: 4 additions & 4 deletions src/doc/en/reference/footer.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Indices and Tables
==================

* `Index <../genindex.html>`_
* `Module Index <../py-modindex.html>`_
* `Search Page <../search.html>`_

..
comment: the following math environment forces Sphinx to load MathJax
in the index.rst pages. Do not delete it!

.. math::
:nowrap:

* `Index <../genindex.html>`_
* `Module Index <../py-modindex.html>`_
* `Search Page <../search.html>`_
16 changes: 14 additions & 2 deletions src/doc/en/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Welcome to the Sage Reference Manual!
Here you find documentation for all of `Sage <http://www.sagemath.org/>`_'s
features, illustrated with lots of examples. A thematic index follows.

This documentation is licensed under the `Creative Commons Attribution-Share Alike 3.0 License`__:math:`.`
This documentation is licensed under the `Creative Commons Attribution-Share Alike 3.0 License`__.

__ http://creativecommons.org/licenses/by-sa/3.0/

Expand Down Expand Up @@ -97,7 +97,7 @@ Geometry, Topology, and Homological Algebra

* :doc:`Euclidean Spaces and Vector Calculus <euclidean_spaces/index>`
* :doc:`Combinatorial and Discrete Geometry <discrete_geometry/index>`
* :doc:`Cell Complexes, Simplicial Complexes, and
* :doc:`Cell Complexes, Simplicial Complexes, and
Simplicial Sets <topology/index>`
* :doc:`Manifolds and Differential Geometry <manifolds/index>`
* :doc:`Hyperbolic Geometry <hyperbolic_geometry/index>`
Expand Down Expand Up @@ -157,6 +157,11 @@ Interfaces
* :doc:`C/C++ Library Interfaces <libs/index>`
* :doc:`Python Technicalities <cpython/index>`

Documentation System
--------------------

* :doc:`Documentation System <documentation/index>`

General Information
===================

Expand All @@ -170,3 +175,10 @@ Indices and Tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

..
comment: the following math environment forces Sphinx to load MathJax
in the index.rst pages. Do not delete it!
.. math::
:nowrap:
6 changes: 3 additions & 3 deletions src/doc/en/thematic_tutorials/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

from sage.docs.conf import release
from sage.docs.conf import *
from sage_docbuild.conf import release
from sage_docbuild.conf import *

# Add any paths that contain custom static files (such as style sheets),
# relative to this directory to html_static_path. They are copied after the
# builtin static files, so a file named "default.css" will overwrite the
# builtin "default.css". html_common_static_path imported from sage.docs.conf
# builtin "default.css". html_common_static_path imported from sage_docbuild.conf
# contains common paths.
html_static_path = [] + html_common_static_path

Expand Down
Loading

0 comments on commit 80e39a1

Please sign in to comment.