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 #8812

Merged
merged 10 commits into from
Jun 1, 2023
Merged

Fix documentation #8812

merged 10 commits into from
Jun 1, 2023

Conversation

ptormene
Copy link
Member

@ptormene ptormene commented May 26, 2023

Fixes #8629

I've fixed some broken cross-references, a malformed table, some indentation issues and various details.
I've added the parameter -W to sphinx-build, to let the build fail in case of any error or warning. Unfortunately I couldn't find any way to let the build produce an exit code different from 0 in case of errors (without -W also errors are ignored, not only warnings).
Sphinx was complaining about language = None and it was falling back to 'en'. I made it explicit. Please @nastasi-oq check if it was not set on purpose.

@ptormene ptormene added this to the Engine 3.17.0 milestone May 26, 2023
@ptormene ptormene requested review from nastasi-oq and micheles May 26, 2023 14:28
@ptormene ptormene self-assigned this May 26, 2023
@micheles
Copy link
Contributor

There was a bug with the exit code of sphinx 6 years ago, but they say it is fixed: sphinx-doc/sphinx#4160 (?)

@ptormene
Copy link
Member Author

I've found also this discussion from April 2022: sphinx-doc/sphinx#10397
So it looks like the problem of the wrong status code was not fixed 6 years ago.

@ptormene
Copy link
Member Author

ptormene commented May 31, 2023

After

  • adding a fallback in case of missing json files for html_theme_options switcher, and
  • declaring a the unicode character "⋮" to be mapped by Latex as \vdots,

now I have this green: https://github.com/gem/oq-engine/actions/runs/5133991839/jobs/9237350113
therefore I believe this PR is now ready to be merged.

@ptormene ptormene merged commit a3e0aef into master Jun 1, 2023
@ptormene ptormene deleted the fix-doc branch June 1, 2023 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The sphinx docs are not built correctly and the errors are silent
2 participants