Skip to content

Commit

Permalink
Merge branch 'v3.2-latest'
Browse files Browse the repository at this point in the history
  • Loading branch information
dpvc committed Jan 13, 2024
2 parents c08ea76 + 174122a commit 1ac57ad
Show file tree
Hide file tree
Showing 11 changed files with 100 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ jobs:
steps:
- uses: actions/checkout@v3
- run: pip install codespell
- run: codespell --ignore-words-list=braket,ket,merrors,merror,multline
- run: codespell --ignore-words-list=braket,ket,merrors,merror,multline,oint
35 changes: 35 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: ./conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true

# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: requirements.txt
2 changes: 1 addition & 1 deletion input/tex/extensions/autoload.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ The default autoload definitions are the following:
enclose: ['enclose'],
extpfeil: ['xtwoheadrightarrow', 'xtwoheadleftarrow', 'xmapsto',
'xlongequal', 'xtofrom', 'Newextarrow'],
html: ['data', 'href', 'class', 'style', 'cssId'],
html: ['href', 'class', 'style', 'cssId'],
mhchem: ['ce', 'pu'],
newcommand: ['newcommand', 'renewcommand', 'newenvironment', 'renewenvironment', 'def', 'let'],
unicode: ['unicode'],
Expand Down
10 changes: 2 additions & 8 deletions input/tex/extensions/html.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ html
####

The `html` extension gives you access to some HTML features like
styles, classes, element ID's, data-* attributes, and clickable links. It defines the
styles, classes, element ID's, and clickable links. It defines the
following non-standard macros:

.. describe:: \\href{url}{math}
Expand Down Expand Up @@ -37,10 +37,6 @@ following non-standard macros:
Adds the give ``css`` declarations to the element associated with
``math``.

.. describe:: \\data{dataset}{math}

Adds `data-* <https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/data-*>`__ attributes to the element associated with ``math``.

For example:

.. code-block:: latex
Expand All @@ -51,8 +47,6 @@ For example:

(x+1)^2 = \cssId{step1}{\style{visibility:hidden}{(x+1)(x+1)}}

x = \data{during=quadratic}{\frac{-b\pm\sqrt{b^2-4ac}}{2a}}

.. Note::

For the ``\href`` macro, the `url` parameter is not processed
Expand Down Expand Up @@ -87,7 +81,7 @@ html Commands
-------------

The `html` extension implements the following macros:
``\class``, ``\cssId``, ``\data``, ``\href``, ``\style``
``\class``, ``\cssId``, ``\href``, ``\style``


|-----|
3 changes: 1 addition & 2 deletions input/tex/extensions/textmacros.rst
Original file line number Diff line number Diff line change
Expand Up @@ -256,8 +256,7 @@ HTML Commands
-------------

.. list-table::
* - ``\data``
- specify data-* attributes

* - ``\href``
- make hyperlink
* - ``\style``
Expand Down
2 changes: 0 additions & 2 deletions input/tex/macros/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -601,8 +601,6 @@ D
- **ams**
* - ``\dashv``
-
* - ``\data``
- **html**
* - ``\dbinom``
- **ams**
* - ``\dblcolon``
Expand Down
2 changes: 1 addition & 1 deletion options/accessibility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ settings:
options: {
menuOptions: {
settings: {
assistiveMml: true, // true to enable assitive MathML
assistiveMml: true, // true to enable assistive MathML
collapsible: false, // true to enable collapsible math
explorer: false // true to enable the expression explorer
}
Expand Down
2 changes: 1 addition & 1 deletion options/input/tex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Option Descriptions
}
};
This loads the :ref:`tex-enclose` extension and acticates it by
This loads the :ref:`tex-enclose` extension and activates it by
including it in the package list.

You can remove packages from the default list using ``'[-]'``
Expand Down
1 change: 1 addition & 0 deletions requirements.in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx_rtd_theme
56 changes: 56 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
#
# This file is autogenerated by pip-compile with Python 3.12
# by the following command:
#
# pip-compile --strip-extras requirements.in
#
alabaster==0.7.16
# via sphinx
babel==2.14.0
# via sphinx
certifi==2023.11.17
# via requests
charset-normalizer==3.3.2
# via requests
docutils==0.20.1
# via
# sphinx
# sphinx-rtd-theme
idna==3.6
# via requests
imagesize==1.4.1
# via sphinx
jinja2==3.1.3
# via sphinx
markupsafe==2.1.3
# via jinja2
packaging==23.2
# via sphinx
pygments==2.17.2
# via sphinx
requests==2.31.0
# via sphinx
snowballstemmer==2.2.0
# via sphinx
sphinx==7.2.6
# via
# sphinx-rtd-theme
# sphinxcontrib-jquery
sphinx-rtd-theme==2.0.0
# via -r requirements.in
sphinxcontrib-applehelp==1.0.8
# via sphinx
sphinxcontrib-devhelp==1.0.6
# via sphinx
sphinxcontrib-htmlhelp==2.0.5
# via sphinx
sphinxcontrib-jquery==4.1
# via sphinx-rtd-theme
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==1.0.7
# via sphinx
sphinxcontrib-serializinghtml==1.1.10
# via sphinx
urllib3==2.1.0
# via requests
2 changes: 1 addition & 1 deletion web/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In addition, there are examples for:
* :ref:`Configuring MathJax using an external script <local-configuration-file>`
* :ref:`Configuring and loading MathJax using one local file <config-loads-mathjax>`
* :ref:`Synchronizing with MathJax using promises <typeset-async>`
* :ref:`Reseting TeX equation numbering <tex-reset>`
* :ref:`Resetting TeX equation numbering <tex-reset>`
* :ref:`Updating previously typeset content <typeset-clear>`
* :ref:`Looking up the math on the page <get-math-items>`
* :ref:`Loading MathJax only on pages with math <load-for-math>`
Expand Down

0 comments on commit 1ac57ad

Please sign in to comment.