suricata icon indicating copy to clipboard operation
suricata copied to clipboard

docs - add docutils.conf to disable smart quotes

Open wesinator opened this issue 3 years ago • 5 comments

Make sure these boxes are signed before submitting your Pull Request -- thank you.

  • [x] I have read the contributing guide lines at https://redmine.openinfosecfoundation.org/projects/suricata/wiki/Contributing
  • [x] I have signed the Open Information Security Foundation contribution agreement at https://suricata-ids.org/about/contribution-agreement/
  • [x] I have updated the user guide (in doc/userguide/) to reflect the changes made (if applicable)

Describe changes:

  • Disable use of stupid Unicode smart quotes in readthedocs

fixes examples such as https://suricata.readthedocs.io/en/latest/rules/dns-keywords.html#dns-query

image

Regards,

#suricata-verify-pr: #suricata-verify-repo: #suricata-verify-branch: #suricata-update-pr: #suricata-update-repo: #suricata-update-branch: #libhtp-pr: #libhtp-repo: #libhtp-branch:

wesinator avatar Mar 03 '21 11:03 wesinator

AFAIR we already thought about that. The Build fail is not due to this IMHO.

norg avatar Mar 07 '21 21:03 norg

AFAIR we already thought about that. The Build fail is not due to this IMHO.

I submitted a PR for this earlier but it wasn't clean and didn't seem to get merged. this one is good.

thanks and regards,

wesinator avatar Mar 08 '21 15:03 wesinator

Codecov Report

Merging #5950 (bb3748c) into master (e964643) will increase coverage by 4.23%. The diff coverage is n/a.

:exclamation: Current head bb3748c differs from pull request most recent head a2e6311. Consider uploading reports for the commit a2e6311 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5950      +/-   ##
==========================================
+ Coverage   72.50%   76.73%   +4.23%     
==========================================
  Files         604      612       +8     
  Lines      179687   188364    +8677     
==========================================
+ Hits       130281   144543   +14262     
+ Misses      49406    43821    -5585     
Flag Coverage Δ
fuzzcorpus 52.53% <ø> (?)
suricata-verify 50.10% <ø> (+0.20%) :arrow_up:
unittests 63.01% <ø> (-0.07%) :arrow_down:

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

codecov[bot] avatar Mar 24 '21 11:03 codecov[bot]

LGTM

jlucovsky avatar Mar 24 '21 13:03 jlucovsky

@jlucovsky can you merge this ?

thx

p.s. Happy holidays

wesinator avatar Dec 22 '21 02:12 wesinator

Sorry just getting back to this now, could you set a proper git author? I can also do it for you on merge if you let me know what it should be. We use "Firstname Lastname "

victorjulien avatar May 05 '23 08:05 victorjulien

Sorry just getting back to this now, could you set a proper git author? I can also do it for you on merge if you let me know what it should be. We use "Firstname Lastname "

amended. thanks,

wesinator avatar May 05 '23 15:05 wesinator

Merged after rebase in #8829, thanks Wes!

victorjulien avatar May 06 '23 20:05 victorjulien