Skip to content

Use h3 tags for admonition titles#7846

Merged
hssyoo merged 1 commit into
aws:developfrom
hssyoo:html-doc-update
Apr 25, 2023
Merged

Use h3 tags for admonition titles#7846
hssyoo merged 1 commit into
aws:developfrom
hssyoo:html-doc-update

Conversation

@hssyoo
Copy link
Copy Markdown
Contributor

@hssyoo hssyoo commented Apr 24, 2023

This PR overrides Sphinx's default HTMLTranslator method for admonitions so that admonition titles have the h3 tag rather than the p tag. This should make it more obvious for people using screen readers that admonitions such as notes and warnings are their own sections.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

Merging #7846 (d35d25d) into develop (634a2bd) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           develop   #7846      +/-   ##
==========================================
- Coverage     0.08%   0.08%   -0.01%     
==========================================
  Files          206     206              
  Lines        16495   16499       +4     
==========================================
  Hits            14      14              
- Misses       16481   16485       +4     

see 1 file with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@hssyoo hssyoo merged commit 56afca2 into aws:develop Apr 25, 2023
@hssyoo hssyoo deleted the html-doc-update branch April 25, 2023 14:25
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.

3 participants