Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: convert recommonmark to myst-parser #551

Merged
merged 2 commits into from
Apr 15, 2021
Merged

docs: convert recommonmark to myst-parser #551

merged 2 commits into from
Apr 15, 2021

Conversation

henryiii
Copy link
Member

@henryiii henryiii commented Apr 15, 2021

A direct switch seems to be trivial. CC readthedocs/recommonmark#221

@github-actions github-actions bot added the needs changelog Might need a changelog entry label Apr 15, 2021
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Apr 15, 2021

Sourcery Code Quality Report

Merging this PR leaves code quality unchanged.

Quality metrics Before After Change
Complexity 0.94 ⭐ 0.94 ⭐ 0.00
Method Length 68.40 🙂 68.40 🙂 0.00
Working memory 11.04 😞 11.04 😞 0.00
Quality 70.28% 🙂 70.28% 🙂 0.00%
Other metrics Before After Change
Lines 186 186 0
Changed files Quality Before Quality After Quality Change
setup.py 47.65% 😞 47.65% 😞 0.00%
docs/conf.py 77.82% ⭐ 77.82% ⭐ 0.00%

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation

Legend and Explanation

The emojis denote the absolute quality of the code:

  • ⭐ excellent
  • 🙂 good
  • 😞 poor
  • ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.


Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Let us know what you think of it by mentioning @sourcery-ai in a comment.

@henryiii henryiii removed the needs changelog Might need a changelog entry label Apr 15, 2021
@henryiii henryiii marked this pull request as ready for review April 15, 2021 21:49
@henryiii henryiii changed the title docs: remove recommonmark docs: convert recommonmark to myst-parser Apr 15, 2021
@henryiii henryiii merged commit 197131e into develop Apr 15, 2021
@henryiii henryiii deleted the docs/md branch April 15, 2021 22:22
henryiii added a commit that referenced this pull request Apr 28, 2021
* docs: remove recommonmark

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant