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

fix: deprecate pygments related variable to correct typos #1614

Merged
merged 2 commits into from
May 21, 2024

Conversation

12rambau
Copy link
Collaborator

@12rambau 12rambau commented Jan 3, 2024

Fix #1594

As mentioned in the issue, the code highlighting lib name is "pygments" and not "pygment". I tracked down all occurences of the word "pygment" without "S" and updated it. Deprecation cycle is due to v1.0.

changes:

  • create a pygments_light_style/pygments_dark_style parameter
  • make a sanity check at theme option init
  • change pygments filename

@12rambau 12rambau marked this pull request as ready for review January 3, 2024 16:00
fix: change the html_theme options to match pygments name
fix: rollback package deps

Previous HEAD was c227736
@Carreau
Copy link
Collaborator

Carreau commented May 21, 2024

Rebase (and squashed for soimplicity).

Copy link

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  src/pydata_sphinx_theme
  __init__.py
  pygments.py
Project Total  

This report was generated by python-coverage-comment-action

src/pydata_sphinx_theme/__init__.py Outdated Show resolved Hide resolved
tests/test_build.py Outdated Show resolved Hide resolved
src/pydata_sphinx_theme/__init__.py Outdated Show resolved Hide resolved
@drammock
Copy link
Collaborator

Thanks for rebasing this @Carreau. Assuming I didn't break anything by editing through GH web UI, this can be merged when CIs are green.

@drammock drammock merged commit 878411e into pydata:main May 21, 2024
18 checks passed
ivanov pushed a commit to ivanov/pydata-sphinx-theme that referenced this pull request Jun 5, 2024
* refactor: rename variables

fix: change the html_theme options to match pygments name
fix: rollback package deps

Previous HEAD was c227736

* Apply suggestions from code review

---------

Co-authored-by: Daniel McCloy <dan@mccloy.info>
Carreau pushed a commit that referenced this pull request Jun 13, 2024
a couple bits that were missed in #1614
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.

Rename html_theme_options keys "pygment_light_style" and "pygment_dark_style"
3 participants