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: Add formatting for definition/field/apidoc lists #191

Merged
merged 3 commits into from
Aug 25, 2020

Conversation

chrisjsewell
Copy link
Member

closes #158

The CSS for the API doc components is taken from the RTD theme CSS, which I converted to SCSS here: https://gist.github.com/chrisjsewell/0f414e6c13e714f9cf70c36f20efaafa
There can possibly be some "pruning" of unneeded elements?

As noted in the scss, field list should be a different format, but that format is a little tricky (see pydata/pydata-sphinx-theme#193) and not widely used, so I think tackle that in a separate issue/PR

@pradyunsg I also added nitpick mode (to check for missing refs) to the nox sphinx-build commands

@codecov
Copy link

codecov bot commented Aug 25, 2020

Codecov Report

Merging #191 into master will increase coverage by 0.10%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #191      +/-   ##
==========================================
+ Coverage   91.45%   91.56%   +0.10%     
==========================================
  Files           2        2              
  Lines         234      237       +3     
==========================================
+ Hits          214      217       +3     
  Misses         20       20              
Flag Coverage Δ
#pytests 91.56% <100.00%> (+0.10%) ⬆️

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

Impacted Files Coverage Δ
sphinx_book_theme/__init__.py 91.51% <ø> (ø)
sphinx_book_theme/launch.py 91.66% <100.00%> (+0.36%) ⬆️

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 dd1ad93...e59cf2e. Read the comment docs.

@chrisjsewell
Copy link
Member Author

Ok merge this and make a release, because I need it for myst-parser

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.

No CSS for general definition (dl,dt,dd) tags
1 participant