Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: executablebooks/MyST-Parser Loading
base: v0.17.2
Choose a base ref
...
head repository: executablebooks/MyST-Parser Loading
compare: v0.18.0
Choose a head ref
  • 7 commits
  • 141 files changed
  • 2 contributors

Commits on Apr 20, 2022

  1. 👌 IMPROVE: Do not let sphinx check the config type (#559)

    This is already validated by myst-parser
    chrisjsewell committed Apr 20, 2022
    Configuration menu
    Copy the full SHA
    7dda7b5 View commit details
    Browse the repository at this point in the history

Commits on May 12, 2022

  1. ♻️📚 Restructure code base and documentation (#566)

    This PR restructures the code base into modules, to be more coherent as to the purpose of each module.
    
    It also restructures the documentation, to make it easier for users to follow, and expose the core concerns at the top-level.
    
    Finally, it introduces document-level configuration *via* the Markdown top-matter, under the `myst` key.
    This configuration is generated from the code `MdParserConfig` dataclass, so is inherently consistent with global configuration.
    The (YAML) top-matter of a MyST file is always read (within the docutils/sphinx parsers) before the full document is parsed, in order to acquire this file configuration, which overrides the default/global configuration (see `docs/configuration.md`).
    
    ## Breaking changes
    
    This should not be breaking, for general users of the sphinx extension,
    but will be for anyone directly using the Python API, mainly just requiring changes in import module paths.
    
    The `to_docutils`, `to_html`, `to_tokens` (from `myst_parser/main.py`) and `mock_sphinx_env`/`parse` (from `myst_parser.sphinx_renderer.py`) functions have been removed.
    These were really just for testing, and were confusing for users, since they did not run the full sphinx build.
    Instead, for single page builds, users should use the recently added docutils parser API/CLI (see `docs/docutils.md`),
    and for testing, functionality has been moved to https://github.com/chrisjsewell/sphinx-pytest.
     
    The top-level `html_meta` and `substitutions` top-matter keys have also been deprecated (i.e. they will still work but will emit a warning), as they now form part of the `myst` config, e.g.
    
    ```yaml
    ---
    html_meta:
      "description lang=en": "metadata description"
    substitutions:
      key1: I'm a **substitution**
    ---
    ```
    
    is replaced by:
    
    ```yaml
    ---
    myst:
      html_meta:
        "description lang=en": "metadata description"
      substitutions:
        key1: I'm a **substitution**
    ---
    ```
    chrisjsewell committed May 12, 2022
    Configuration menu
    Copy the full SHA
    602470e View commit details
    Browse the repository at this point in the history

Commits on May 15, 2022

  1. Configuration menu
    Copy the full SHA
    3c45b7e View commit details
    Browse the repository at this point in the history

Commits on Jun 7, 2022

  1. 2 Configuration menu
    Copy the full SHA
    2e91dd8 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    cc44a35 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    c17d855 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    75ef9cb View commit details
    Browse the repository at this point in the history
Loading