Skip to content

Commit 1ac57ad

Browse files
committed
Merge branch 'v3.2-latest'
2 parents c08ea76 + 174122a commit 1ac57ad

File tree

11 files changed

+100
-17
lines changed

11 files changed

+100
-17
lines changed

.github/workflows/codespell.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ jobs:
77
steps:
88
- uses: actions/checkout@v3
99
- run: pip install codespell
10-
- run: codespell --ignore-words-list=braket,ket,merrors,merror,multline
10+
- run: codespell --ignore-words-list=braket,ket,merrors,merror,multline,oint

.readthedocs.yaml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version and other tools you might need
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.12"
12+
# You can also specify other tool versions:
13+
# nodejs: "20"
14+
# rust: "1.70"
15+
# golang: "1.20"
16+
17+
# Build documentation in the "docs/" directory with Sphinx
18+
sphinx:
19+
configuration: ./conf.py
20+
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
21+
# builder: "dirhtml"
22+
# Fail on all warnings to avoid broken references
23+
# fail_on_warning: true
24+
25+
# Optionally build your docs in additional formats such as PDF and ePub
26+
# formats:
27+
# - pdf
28+
# - epub
29+
30+
# Optional but recommended, declare the Python requirements required
31+
# to build your documentation
32+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
33+
python:
34+
install:
35+
- requirements: requirements.txt

input/tex/extensions/autoload.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ The default autoload definitions are the following:
135135
enclose: ['enclose'],
136136
extpfeil: ['xtwoheadrightarrow', 'xtwoheadleftarrow', 'xmapsto',
137137
'xlongequal', 'xtofrom', 'Newextarrow'],
138-
html: ['data', 'href', 'class', 'style', 'cssId'],
138+
html: ['href', 'class', 'style', 'cssId'],
139139
mhchem: ['ce', 'pu'],
140140
newcommand: ['newcommand', 'renewcommand', 'newenvironment', 'renewenvironment', 'def', 'let'],
141141
unicode: ['unicode'],

input/tex/extensions/html.rst

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ html
55
####
66

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

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

40-
.. describe:: \\data{dataset}{math}
41-
42-
Adds `data-* <https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/data-*>`__ attributes to the element associated with ``math``.
43-
4440
For example:
4541

4642
.. code-block:: latex
@@ -51,8 +47,6 @@ For example:
5147

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

54-
x = \data{during=quadratic}{\frac{-b\pm\sqrt{b^2-4ac}}{2a}}
55-
5650
.. Note::
5751

5852
For the ``\href`` macro, the `url` parameter is not processed
@@ -87,7 +81,7 @@ html Commands
8781
-------------
8882

8983
The `html` extension implements the following macros:
90-
``\class``, ``\cssId``, ``\data``, ``\href``, ``\style``
84+
``\class``, ``\cssId``, ``\href``, ``\style``
9185

9286

9387
|-----|

input/tex/extensions/textmacros.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,7 @@ HTML Commands
256256
-------------
257257

258258
.. list-table::
259-
* - ``\data``
260-
- specify data-* attributes
259+
261260
* - ``\href``
262261
- make hyperlink
263262
* - ``\style``

input/tex/macros/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -601,8 +601,6 @@ D
601601
- **ams**
602602
* - ``\dashv``
603603
-
604-
* - ``\data``
605-
- **html**
606604
* - ``\dbinom``
607605
- **ams**
608606
* - ``\dblcolon``

options/accessibility.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ settings:
2828
options: {
2929
menuOptions: {
3030
settings: {
31-
assistiveMml: true, // true to enable assitive MathML
31+
assistiveMml: true, // true to enable assistive MathML
3232
collapsible: false, // true to enable collapsible math
3333
explorer: false // true to enable the expression explorer
3434
}

options/input/tex.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Option Descriptions
8989
}
9090
};
9191
92-
This loads the :ref:`tex-enclose` extension and acticates it by
92+
This loads the :ref:`tex-enclose` extension and activates it by
9393
including it in the package list.
9494

9595
You can remove packages from the default list using ``'[-]'``

requirements.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
sphinx_rtd_theme

requirements.txt

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
#
2+
# This file is autogenerated by pip-compile with Python 3.12
3+
# by the following command:
4+
#
5+
# pip-compile --strip-extras requirements.in
6+
#
7+
alabaster==0.7.16
8+
# via sphinx
9+
babel==2.14.0
10+
# via sphinx
11+
certifi==2023.11.17
12+
# via requests
13+
charset-normalizer==3.3.2
14+
# via requests
15+
docutils==0.20.1
16+
# via
17+
# sphinx
18+
# sphinx-rtd-theme
19+
idna==3.6
20+
# via requests
21+
imagesize==1.4.1
22+
# via sphinx
23+
jinja2==3.1.3
24+
# via sphinx
25+
markupsafe==2.1.3
26+
# via jinja2
27+
packaging==23.2
28+
# via sphinx
29+
pygments==2.17.2
30+
# via sphinx
31+
requests==2.31.0
32+
# via sphinx
33+
snowballstemmer==2.2.0
34+
# via sphinx
35+
sphinx==7.2.6
36+
# via
37+
# sphinx-rtd-theme
38+
# sphinxcontrib-jquery
39+
sphinx-rtd-theme==2.0.0
40+
# via -r requirements.in
41+
sphinxcontrib-applehelp==1.0.8
42+
# via sphinx
43+
sphinxcontrib-devhelp==1.0.6
44+
# via sphinx
45+
sphinxcontrib-htmlhelp==2.0.5
46+
# via sphinx
47+
sphinxcontrib-jquery==4.1
48+
# via sphinx-rtd-theme
49+
sphinxcontrib-jsmath==1.0.1
50+
# via sphinx
51+
sphinxcontrib-qthelp==1.0.7
52+
# via sphinx
53+
sphinxcontrib-serializinghtml==1.1.10
54+
# via sphinx
55+
urllib3==2.1.0
56+
# via requests

0 commit comments

Comments
 (0)