markdown-it-py icon indicating copy to clipboard operation
markdown-it-py copied to clipboard

📚 DOCS: Format docs with mdformat-myst

Open hukkin opened this issue 4 years ago • 3 comments

@chrisjsewell not sure if you want this merged, but if nothing else, this is to showcase and let you know that a MyST formatter exists :wink:

In addition to auto-formatting the docs, this PR fixes an exclude in pre-commit config (benchmark folder changed to benchmarking) and fixes incorrect list indentation in contributing.md.

hukkin avatar Apr 15 '21 13:04 hukkin

Codecov Report

Merging #156 (c112fcc) into master (53d9b33) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #156   +/-   ##
=======================================
  Coverage   96.10%   96.10%           
=======================================
  Files          60       60           
  Lines        3232     3232           
=======================================
  Hits         3106     3106           
  Misses        126      126           
Flag Coverage Δ
pytests 96.10% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 53d9b33...c112fcc. Read the comment docs.

codecov[bot] avatar Apr 15 '21 13:04 codecov[bot]

RTD build will fail because it has these dependencies

  • myst-parser
  • markdown-it-py == <current-version>, that is since RTD requirements are specified as pip install .[rtd], RTD implicitly has markdown-it-py's current version as dependency

A conflict comes from the fact that myst-parser requires markdown-it-py~=0.6.2, which is incompatible with pip install ..

To fix this, I recommend making RTD not implicitly require the package itself. One solution is to remove the rtd install extra and replace it with docs/requirements.txt.

hukkin avatar Apr 15 '21 13:04 hukkin

Thanks I'll check it out soonish

But yeh I want RTD to build with the develop version of markdown-it-py. This is a known issue, but will be less problematic once myst-parser (and jupytext) are pinning to ~1.0 where it should be a good while before a back-incompatible v2

chrisjsewell avatar Apr 15 '21 14:04 chrisjsewell