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.

Sign up for GitHub

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

Jump to bottom

Make HTML5 writer default #4587

Closed
tk0miya opened this issue Feb 10, 2018 · 1 comment
Closed

Make HTML5 writer default #4587

tk0miya opened this issue Feb 10, 2018 · 1 comment
Labels
builder:html type:enhancement enhance or introduce a new feature
Milestone
2.0.0

Comments

@tk0miya
Copy link
Member

tk0miya commented Feb 10, 2018

Problem

  • Since 1.6, HTML5 writer was added
  • Making it default writer of HTML builder
  • And making HTML4 optional (while we supports docutils-1.2, a.k.a 2.0)

Action

  • Check the rendered HTML is fine for some themes.
  • Remove tests for html4 writer (then our testing becomes faster!)
  • Update HTML builder to switch default writer
  • Add way to use HTML4 builder manually
@tk0miya tk0miya added type:enhancement enhance or introduce a new feature builder:html labels Feb 10, 2018
@tk0miya tk0miya added this to the 1.8 milestone Feb 10, 2018
@tk0miya tk0miya modified the milestones: 1.8.0, 2.0 Aug 19, 2018
@tk0miya tk0miya mentioned this issue Jan 12, 2019
Merged
@tk0miya
Copy link
Member Author

tk0miya commented Feb 11, 2019

done with #5927!

@tk0miya tk0miya closed this as completed Feb 11, 2019
openstack-gerrit pushed a commit to openstack/os-api-ref that referenced this issue Apr 26, 2019
@stephenfin
Add support for Sphinx 2.0
525eee5 
Sphinx 2.0 switched the default HTML builder from HTML4 to HTML5 [1].
Since some of our tests are validating raw HTML output, this has caused
them to break. We can't drop support for Sphinx < 2.0 yet since Sphinx
2.0 doesn't support Python 2.7, so simply if-else this mofo until such a
time as we _can_ drop support.

[1] sphinx-doc/sphinx#4587

Change-Id: I4631169908e34fa924f5a0a783a94ad9c1215d9f
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
openstack-gerrit pushed a commit to openstack/openstack that referenced this issue Apr 26, 2019
@stephenfin @openstack-gerrit
Update git submodules
84ccdbd 
* Update os-api-ref from branch 'master'
  - Add support for Sphinx 2.0
    
    Sphinx 2.0 switched the default HTML builder from HTML4 to HTML5 [1].
    Since some of our tests are validating raw HTML output, this has caused
    them to break. We can't drop support for Sphinx < 2.0 yet since Sphinx
    2.0 doesn't support Python 2.7, so simply if-else this mofo until such a
    time as we _can_ drop support.
    
    [1] sphinx-doc/sphinx#4587
    
    Change-Id: I4631169908e34fa924f5a0a783a94ad9c1215d9f
    Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
    
  - OpenDev Migration Patch
    
    This commit was bulk generated and pushed by the OpenDev sysadmins
    as a part of the Git hosting and code review systems migration
    detailed in these mailing list posts:
    
    http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
    http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html
    
    Attempts have been made to correct repository namespaces and
    hostnames based on simple pattern matching, but it's possible some
    were updated incorrectly or missed entirely. Please reach out to us
    via the contact information listed at https://opendev.org/ with any
    questions you may have.
@abitrolly abitrolly mentioned this issue Jan 20, 2021
Open
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 7, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
builder:html type:enhancement enhance or introduce a new feature
Projects
None yet
Milestone
2.0.0
Development

No branches or pull requests
1 participant
@tk0miya