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 documentation issues for Sphinx upgrade #7329

Closed
exalate-issue-sync bot opened this issue May 11, 2023 · 6 comments
Closed

Fix documentation issues for Sphinx upgrade #7329

exalate-issue-sync bot opened this issue May 11, 2023 · 6 comments
Assignees

Comments

@exalate-issue-sync
Copy link

Fix any issues that are created by the Sphinx upgrade. Examples found so far include:

  • bulleted lists must not have spaces between the items. this is probably on a lot of pages... !Screen Shot 2021-09-12 at 11.20.12 PM.png|thumbnail! !Screen Shot 2021-09-12 at 11.22.49 PM.png|thumbnail!
  • images are no longer centered (see [AutoML logo|https://docs.h2o.ai/h2o/latest-stable/h2o-docs/automl.html])

Seems to work ok on older Sphinx (for me, worked fine on v2.1.1). You could test by upgrading to latest version of Sphinx locally to make sure there's no further issues.

@exalate-issue-sync
Copy link
Author

Adam Valenta commented: Issue is fixed by this PR [https://github.com//pull/5957|https://github.com//pull/5957|smart-link]

@exalate-issue-sync
Copy link
Author

Erin LeDell commented: I think this is not totally fixed yet? It’s an environment issue, not a code issue.

@exalate-issue-sync
Copy link
Author

Adam Valenta commented: It is fixed, I have created separate internal issue for the infrastructure cleanup [https://h2oai.atlassian.net/browse/ITA-1003|https://h2oai.atlassian.net/browse/ITA-1003|smart-link].

@exalate-issue-sync
Copy link
Author

Adam Valenta commented: BTW when we upgrade to sphinx==4.2.0, we have to also upgrade sphinx_prompt==1.5.0, sphinx-tabs==3.2.0, and docutils==0.16

The current code works only with sphinx_substitution_extensions==2019.6.15.0 but it is officially not compatible, but the documentation looks good to me, only Tabs changed their color.

!Screenshot 2021-12-23 at 13.02.22.png|width=2560,height=1440!

@h2o-ops-ro
Copy link
Collaborator

JIRA Issue Details

Jira Issue: PUBDEV-8327
Assignee: hannah.tillman
Reporter: Erin LeDell
State: Resolved
Fix Version: 3.36.0.1
Attachments: Available (Count: 3)
Development PRs: N/A

@h2o-ops-ro
Copy link
Collaborator

Attachments From Jira

Attachment Name: Screen Shot 2021-09-12 at 11.20.12 PM.png
Attached By: Erin LeDell
File Link:https://h2o-3-jira-github-migration.s3.amazonaws.com/PUBDEV-8327/Screen Shot 2021-09-12 at 11.20.12 PM.png

Attachment Name: Screen Shot 2021-09-12 at 11.22.49 PM.png
Attached By: Erin LeDell
File Link:https://h2o-3-jira-github-migration.s3.amazonaws.com/PUBDEV-8327/Screen Shot 2021-09-12 at 11.22.49 PM.png

Attachment Name: Screenshot 2021-12-23 at 13.02.22.png
Attached By: Adam Valenta
File Link:https://h2o-3-jira-github-migration.s3.amazonaws.com/PUBDEV-8327/Screenshot 2021-12-23 at 13.02.22.png

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants