build-docs.sh
not exactly the same as Read the Docs
#3132
Labels
Component: Documentation 📄
Issue/PR for markdown and API documentation
good first issue
Good first issues for beginners
For some time I have been unable to build the docs locally, but I've been ignoring the issue because Read the Docs was working fine. This was reported by @lrcouto when she started however.
Now I paid more attention and noticed that
build-docs.sh
(hencemake build-docs
) doeswhereas RTD does the equivalent of
Key thing being
--keep-going
:(so, even if warnings are treated as errors, at least the build proceeds)
I think Sphinx is obscure enough that we can just add
--keep-going
to our script so that contributors can just not worry about this.The text was updated successfully, but these errors were encountered: