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

sphinx doc: treat warnings as errors #5374

Merged
merged 1 commit into from Sep 5, 2023

Conversation

tjhei
Copy link
Member

@tjhei tjhei commented Aug 24, 2023

inspired by #5370

@tjhei
Copy link
Member Author

tjhei commented Aug 24, 2023

/home/docs/checkouts/readthedocs.org/user_builds/aspect-documentation/checkouts/5374/CONTRIBUTING.md:120: WARNING: 'myst' cross-reference target not found: 'doc/modules/changes/' [myst.xref_missing]
/home/docs/checkouts/readthedocs.org/user_builds/aspect-documentation/checkouts/5374/CONTRIBUTING.md:142: WARNING: 'myst' cross-reference target not found: 'doc/modules/' [myst.xref_missing]
/home/docs/checkouts/readthedocs.org/user_builds/aspect-documentation/checkouts/5374/CONTRIBUTING.md:163: WARNING: 'myst' cross-reference target not found: 'AUTHORS.md' [myst.xref_missing]
/home/docs/checkouts/readthedocs.org/user_builds/aspect-documentation/checkouts/5374/CONTRIBUTING.md:167: WARNING: 'myst' cross-reference target not found: 'LICENSE' [myst.xref_missing]

@tjhei
Copy link
Member Author

tjhei commented Aug 24, 2023

@gassmoeller Do you know how to fix this? We also want github to render this markdown files and the links correctly, so I assume we can not use the sphinx doc syntax.

@gassmoeller
Copy link
Member

gassmoeller commented Aug 24, 2023

Yes I noticed these too in #5370, but couldnt find an easy way to fix them. The problem is that Contributing.md is not in the root path of the sphinx documentation and we use the indirect include in doc/sphinx/user/extending/contributing.md to include it, but this breaks relative links. We could modify Contributing.md to directly link to the files on github (instead of using relative links), it's just not as pretty when you read it in a file editor. Thoughts?

@tjhei
Copy link
Member Author

tjhei commented Sep 5, 2023

updated.

@gassmoeller gassmoeller merged commit ebe5f39 into geodynamics:main Sep 5, 2023
7 checks passed
@tjhei tjhei deleted the sphinx-warn-and-pdf branch September 5, 2023 18:23
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.

None yet

2 participants