Merge branch 'master' into issue-204

Author: chrisjsewell

.github/workflows/tests.yml

@@ -7,7 +7,7 @@ on:
   push:
     branches: [master]
     tags:
-      - 'v*'
+      - "v[0-9]+.[0-9]+.[0-9]+*"
   pull_request:
   schedule:
     - cron: '0 0 * * 0'  # every week
@@ -113,19 +113,19 @@ jobs:
     steps:
     - name: Checkout source
       uses: actions/checkout@v2
-    - name: Set up Python 3.7
+    - name: Set up Python 3.8
       uses: actions/setup-python@v2
       with:
-        python-version: '3.7'
-    - name: Build package
+        python-version: '3.8'
+    - name: install flit
       run: |
-        pip install build
-        python -m build
-    - name: Publish
-      uses: pypa/gh-action-pypi-publish@v1.1.0
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_KEY }}
+        pip install flit~=3.4
+    - name: Build and publish
+      run: |
+        flit publish
+      env:
+        FLIT_USERNAME: __token__
+        FLIT_PASSWORD: ${{ secrets.PYPI_KEY }}
 
   allgood:
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -16,40 +16,31 @@ exclude: >
 repos:
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
+    rev: v4.2.0
     hooks:
     - id: check-json
     - id: check-yaml
     - id: end-of-file-fixer
     - id: trailing-whitespace
 
-  - repo: https://github.com/mgedmin/check-manifest
-    rev: "0.46"
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
     hooks:
-    - id: check-manifest
-      args: [--no-build-isolation]
-      additional_dependencies: [setuptools>=46.4.0]
-
-  # this is not used for now,
-  # since it converts markdown-it-py to markdown_it_py and removes comments
-  # - repo: https://github.com/asottile/setup-cfg-fmt
-  #   rev: v1.17.0
-  #   hooks:
-  #   - id: setup-cfg-fmt
+    - id: isort
 
   - repo: https://github.com/psf/black
-    rev: 20.8b1
+    rev: 22.3.0
     hooks:
     - id: black
 
   - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.9.1
+    rev: 3.9.2
     hooks:
     - id: flake8
       additional_dependencies: [flake8-bugbear==21.3.1]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.812
+    rev: v0.942
     hooks:
     - id: mypy
       additional_dependencies: [attrs]

MANIFEST.in

@@ -1,4 +1,5 @@
 from pathlib import Path
+
 import pytest
 
 import markdown_it

benchmarking/bench_core.py

@@ -1,7 +1,8 @@
 from pathlib import Path
-import pytest
 from shutil import which
 
+import pytest
+
 
 @pytest.fixture
 def spec_text():

benchmarking/bench_packages.py

@@ -0,0 +1,5 @@
+.code-cell > .highlight > pre {
+    border-left-color: green;
+    border-left-width: medium;
+    border-left-style: solid;
+}

docs/_static/custom.css

@@ -2,6 +2,7 @@
 
 # markdown-it design principles
 
+(md/data-flow)=
 ## Data flow
 
 Input data is parsed via nested chains of rules. There are 3 nested chains -
@@ -157,10 +158,9 @@ renderer override, but can be more simple.
 You also can write your own renderer to generate other formats than HTML, such as
 JSON/XML... You can even use it to generate AST.
 
-
 ## Summary
 
-This was mentioned in [Data flow](#data-flow), but let's repeat sequence again:
+This was mentioned in [Data flow](md/data-flow), but let's repeat sequence again:
 
 1. Blocks are parsed, and top level of token stream filled with block tokens.
 2. Content on inline containers is parsed, filling `.children` properties.

docs/architecture.md

@@ -33,25 +33,25 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
     "sphinx.ext.intersphinx",
-    "myst_nb",
+    "myst_parser",
     "sphinx_copybutton",
-    "sphinx_panels",
+    "sphinx_design",
 ]
 
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
-
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+nitpicky = True
 nitpick_ignore = [
     ("py:class", "Match"),
+    ("py:class", "Path"),
     ("py:class", "x in the interval [0, 1)."),
     ("py:class", "markdown_it.helpers.parse_link_destination._Result"),
     ("py:class", "markdown_it.helpers.parse_link_title._Result"),
     ("py:class", "MarkdownIt"),
+    ("py:class", "RuleFunc"),
     ("py:class", "_NodeType"),
     ("py:class", "typing_extensions.Protocol"),
 ]
@@ -70,7 +70,8 @@
     "repository_branch": "master",
     "path_to_docs": "docs",
 }
-panels_add_boostrap_css = False
+html_static_path = ["_static"]
+html_css_files = ["custom.css"]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -91,6 +92,7 @@ def run_apidoc(app):
     """
     import os
     import shutil
+
     import sphinx
     from sphinx.ext import apidoc
 
@@ -100,7 +102,7 @@ def run_apidoc(app):
     this_folder = os.path.abspath(os.path.dirname(os.path.realpath(__file__)))
     api_folder = os.path.join(this_folder, "api")
     module_path = os.path.normpath(os.path.join(this_folder, "../"))
-    ignore_paths = ["../setup.py", "../conftest.py", "../tests", "../benchmarking"]
+    ignore_paths = ["../profiler.py", "../conftest.py", "../tests", "../benchmarking"]
     ignore_paths = [
         os.path.normpath(os.path.join(this_folder, p)) for p in ignore_paths
     ]
@@ -120,6 +122,7 @@ def run_apidoc(app):
 
     argv = ["-M", "--separate", "-o", api_folder, module_path] + ignore_paths
 
+    apidoc.OPTIONS.append("ignore-module-all")
     apidoc.main(argv)
 
     # we don't use this
@@ -131,3 +134,17 @@ def setup(app):
     """Add functions to the Sphinx setup."""
     if os.environ.get("SKIP_APIDOC", None) is None:
         app.connect("builder-inited", run_apidoc)
+
+    from sphinx.directives.code import CodeBlock
+
+    class CodeCell(CodeBlock):
+        """Custom code block directive."""
+
+        def run(self):
+            """Run the directive."""
+            self.options["class"] = ["code-cell"]
+            return super().run()
+
+    # note, these could be run by myst-nb,
+    # but currently this causes a circular dependency issue
+    app.add_directive("code-cell", CodeCell)

docs/conf.py

@@ -29,7 +29,6 @@ It can be setup by:
 Editors like VS Code also have automatic code reformat utilities, which can adhere to this standard.
 
 All functions and class methods should be annotated with types and include a docstring.
-The preferred docstring format is outlined in `markdown-it-py/docstring.fmt.mustache` and can be used automatically with the [autodocstring](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring) VS Code extension.
 
 ## Testing
 

docs/contributing.md

@@ -16,7 +16,7 @@ kernelspec:
 
 > This document can be opened to execute with [Jupytext](https://jupytext.readthedocs.io)!
 
-markdown-it-py may be used as an API *via* the `markdown_it` package.
+markdown-it-py may be used as an API *via* the [`markdown-it-py`](https://pypi.org/project/markdown-it-py/) package.
 
 The raw text is first parsed to syntax 'tokens',
 then these are converted to other formats using 'renderers'.