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

Update mkdocs extensions to fix local syntax highlighting #2401

Merged

Conversation

daviskirk
Copy link
Contributor

Change Summary

Update mkdocs extensions to fix local syntax highlighting.

Ran into #2400 as well.

According to https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
the pymdownx.highlight extension supersedes the CodeHilite extension,
the "extra" extension was still causing the syntax highlighting to disappear (it would show up when taking it out).
But apparently, there's https://facelessuser.github.io/pymdown-extensions/extensions/extra/ which also replaces the "extra" extension, and also fixed the syntax highlighting in combination with pymdownx.highlight.

Related issue number

Fixed #2400

Checklist

  • Unit tests for the changes exist
  • Tests pass on CI and coverage remains at 100%
  • Documentation reflects the changes where applicable
  • changes/<pull request or issue id>-<github username>.md file added describing change
    (see changes/README.md for details)

@codecov
Copy link

codecov bot commented Feb 24, 2021

Codecov Report

Merging #2401 (2176043) into master (c8883e3) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2401   +/-   ##
=======================================
  Coverage   99.90%   99.90%           
=======================================
  Files          25       25           
  Lines        5039     5043    +4     
  Branches     1031     1032    +1     
=======================================
+ Hits         5034     5038    +4     
  Misses          1        1           
  Partials        4        4           
Impacted Files Coverage Δ
pydantic/json.py 100.00% <0.00%> (ø)

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 c8883e3...2176043. Read the comment docs.

Copy link
Member

@PrettyWood PrettyWood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! What about attr_list?

@samuelcolvin
Copy link
Member

Thanks so much, it was the extra bit I was missing.

@samuelcolvin
Copy link
Member

samuelcolvin commented Feb 25, 2021

Nice! What about attr_list?

@daviskirk I think we need to keep attr_list.

update: looks like attr_list is active by default also I don't think we use it

@samuelcolvin samuelcolvin merged commit 2c2e238 into pydantic:master Feb 25, 2021
@samuelcolvin
Copy link
Member

thanks so much.

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.

code not highlighted in docs
3 participants