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

userguide: fix css for readthedocs hosted userguide - v1 #9933

Closed
wants to merge 1 commit into from

Conversation

jasonish
Copy link
Member

Looks like we were just using outdated CSS files, so instead, don't manually
bring in any ReadTheDocs CSS files.

Bug: https://redmine.openinfosecfoundation.org/issues/6589

Example of current broken output (note the actions list without bullets):
https://docs.suricata.io/en/suricata-7.0.2/rules/intro.html#action

And with this patch:
https://jasonish-suricata.readthedocs.io/en/latest/rules/intro.html#action

There will be other changes as well by using newer CSS, one appears to be extra spacing in the main TOC as can be seen here:
https://jasonish-suricata.readthedocs.io/en/latest/index.html

In our conf.py we reference some ReadTheDocs stylesheets that appear to
be old and break formatting of some items like bulletted lists.

Bug: OISF#6589
Copy link

codecov bot commented Nov 30, 2023

Codecov Report

Merging #9933 (057475e) into master (9c3ab36) will increase coverage by 0.02%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #9933      +/-   ##
==========================================
+ Coverage   82.35%   82.37%   +0.02%     
==========================================
  Files         972      972              
  Lines      273060   273060              
==========================================
+ Hits       224870   224940      +70     
+ Misses      48190    48120      -70     
Flag Coverage Δ
fuzzcorpus 64.23% <ø> (+0.07%) ⬆️
suricata-verify 61.05% <ø> (-0.05%) ⬇️
unittests 62.92% <ø> (ø)

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

Copy link
Contributor

@jufajardini jufajardini left a comment

Choose a reason for hiding this comment

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

Welcome back, bulleted lists!

The spacing in the TOC makes it easier to read, IMHO.
And I see that this also fixes our sidebar, that is somewhat broken, too, atm.

Many thanks!!

@victorjulien victorjulien added this to the 8.0 milestone Dec 1, 2023
@jufajardini jufajardini added the typo/doc update No code change : only doc or typo fixes label Dec 1, 2023
@victorjulien
Copy link
Member

Merged in #9939, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
typo/doc update No code change : only doc or typo fixes
3 participants