Merge branch 'master' into pre-commit-ci-update-config

.github/dependabot.yml

@@ -0,0 +1,19 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    commit-message:
+      prefix: ⬆️
+    schedule:
+      interval: weekly
+  - package-ecosystem: pip
+    directory: /
+    commit-message:
+      prefix: ⬆️
+    schedule:
+      interval: weekly

.github/workflows/test-formats.yml

@@ -0,0 +1,76 @@
+name: build-doc-formats
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+
+  doc-builds:
+
+    name: Documentation builds
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        format: ["man", "text"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.9
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[linkify,rtd]
+    - name: Build docs
+      run: |
+        sphinx-build -nW --keep-going -b ${{ matrix.format }} docs/ docs/_build/${{ matrix.format }}
+
+  doc-builds-pdf:
+
+    name: Documentation builds
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        format: ["latex"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.9
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[linkify,rtd]
+    - name: Build docs
+      run: |
+        sphinx-build -nW --keep-going -b ${{ matrix.format }} docs/ docs/_build/${{ matrix.format }}
+
+    - name: Make PDF
+      uses: xu-cheng/latex-action@v2
+      with:
+        working_directory: docs/_build/latex
+        root_file: "mystparser.tex"
+        # https://github.com/marketplace/actions/github-action-for-latex#it-fails-due-to-xindy-cannot-be-found
+        pre_compile: |
+          ln -sf /opt/texlive/texdir/texmf-dist/scripts/xindy/xindy.pl /opt/texlive/texdir/bin/x86_64-linuxmusl/xindy
+          ln -sf /opt/texlive/texdir/texmf-dist/scripts/xindy/texindy.pl /opt/texlive/texdir/bin/x86_64-linuxmusl/texindy
+          wget https://sourceforge.net/projects/xindy/files/xindy-source-components/2.4/xindy-kernel-3.0.tar.gz
+          tar xf xindy-kernel-3.0.tar.gz
+          cd xindy-kernel-3.0/src
+          apk add make
+          apk add clisp --repository=http://dl-cdn.alpinelinux.org/alpine/edge/community
+          make
+          cp -f xindy.mem /opt/texlive/texdir/bin/x86_64-linuxmusl/
+          cd ../../
+      env:
+        XINDYOPTS: -L english -C utf8  -M sphinx.xdy

.github/workflows/tests.yml

@@ -13,49 +13,48 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python 3.8
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: "3.8"
-    - uses: pre-commit/action@v2.0.0
+    - uses: pre-commit/action@v3.0.0
 
   tests:
 
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
-        sphinx: [">=5,<6"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        sphinx: [">=6,<7"]
         os: [ubuntu-latest]
         include:
         - os: ubuntu-latest
           python-version: "3.8"
-          sphinx: ">=4,<5"
+          sphinx: ">=5,<6"
         - os: windows-latest
           python-version: "3.8"
-          sphinx: ">=4,<5"
+          sphinx: ">=5,<6"
 
     runs-on: ${{ matrix.os }}
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -e .[linkify,testing]
-        pip install --upgrade-strategy "only-if-needed" "sphinx${{ matrix.sphinx }}"
+        pip install -e ".[linkify,testing]" "sphinx${{ matrix.sphinx }}"
     - name: Run pytest
       run: |
         pytest --cov=myst_parser --cov-report=xml --cov-report=term-missing
         coverage xml
     - name: Upload to Codecov
-      if: github.repository == 'executablebooks/MyST-Parser' && matrix.python-version == 3.8
-      uses: codecov/codecov-action@v1
+      if: github.repository == 'executablebooks/MyST-Parser' && matrix.python-version == 3.8 && matrix.os == 'ubuntu-latest'
+      uses: codecov/codecov-action@v3
       with:
         name: myst-parser-pytests
         flags: pytests
@@ -74,9 +73,9 @@ jobs:
 
     steps:
     - name: Checkout source
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Set up Python 3.8
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: "3.8"
     - name: Install setup
@@ -87,8 +86,7 @@ jobs:
       run: python .github/workflows/docutils_setup.py pyproject.toml README.md
     - name: Install dependencies
       run: |
-        pip install .
-        pip install pytest~=6.2 pytest-param-files~=0.3.3 pygments docutils==${{ matrix.docutils-version }}
+        pip install .[linkify,testing-docutils] docutils==${{ matrix.docutils-version }}
     - name: ensure sphinx is not installed
       run: |
         python -c "\
@@ -99,7 +97,7 @@ jobs:
         else:
             raise AssertionError()"
     - name: Run pytest for docutils-only tests
-      run: pytest tests/test_docutils.py tests/test_renderers/test_fixtures_docutils.py tests/test_renderers/test_include_directive.py
+      run: pytest tests/test_docutils.py tests/test_renderers/test_fixtures_docutils.py tests/test_renderers/test_include_directive.py tests/test_renderers/test_myst_config.py
     - name: Run docutils CLI
       run: echo "test" | myst-docutils-html
 
@@ -111,9 +109,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout source
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Set up Python 3.8
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: "3.8"
     - name: install flit
@@ -134,9 +132,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout source
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Set up Python 3.8
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: "3.8"
     - name: install flit and tomlkit

CHANGELOG.md

@@ -363,7 +363,7 @@ In particular for users, this update alters the parsing of tables to be consiste
 
 ### New Features ✨
 
-- **Task lists** utilise the [markdown-it-py tasklists plugin](markdown_it:md/plugins), and are applied to Markdown list items starting with `[ ]` or `[x]`.
+- **Task lists** utilise the [markdown-it-py tasklists plugin](inv:markdown_it#md/plugins), and are applied to Markdown list items starting with `[ ]` or `[x]`.
 
   ```markdown
   - [ ] An item that needs doing
@@ -437,7 +437,7 @@ A warning (of type `myst.nested_header`) is now emitted when this occurs.
 - ✨ NEW: Add warning types `myst.subtype`:
   All parsing warnings are assigned a type/subtype, and also the messages are appended with them.
   These warning types can be suppressed with the sphinx `suppress_warnings` config option.
-  See [How-to suppress warnings](howto/warnings) for more information.
+  See [How-to suppress warnings](myst-warnings) for more information.
 
 ## 0.13.3 - 2021-01-20
 
@@ -541,7 +541,7 @@ substitutions:
 {{ key1 }}
 ```
 
-The substitutions are assessed as [jinja2 expressions](http://jinja.palletsprojects.com/) and includes the [Sphinx Environment](https://www.sphinx-doc.org/en/master/extdev/envapi.html) as `env`, so you can do powerful thinks like:
+The substitutions are assessed as [jinja2 expressions](http://jinja.palletsprojects.com/) and includes the [Sphinx Environment](inv:sphinx#extdev/envapi) as `env`, so you can do powerful thinks like:
 
 ```
 {{ [key1, env.docname] | join('/') }}

docs/_static/custom.css → docs/_static/local.css

@@ -22,3 +22,31 @@ h3::before {
 .admonition > .admonition-title, div.admonition.no-icon > .admonition-title {
     padding-left: .6rem;
 }
+
+/* Live preview page */
+iframe.pyscript, textarea.pyscript {
+    width: 100%;
+    height: 400px;
+}
+iframe.pyscript {
+    padding: 4px;
+}
+textarea.pyscript {
+    padding: 30px 20px 20px;
+    border-radius: 8px;
+    resize: vertical;
+    font-size: 16px;
+    font-family: monospace;
+}
+.display-flex {
+    display: flex;
+}
+.display-inline-block {
+    display: inline-block;
+    margin-right: 1rem;
+    margin-bottom: 0;
+}
+span.label {
+    /* pyscript changes this and it messes up footnote labels */
+    all: unset;
+}