Closed mpmdean closed 1 year ago
Looks like there is a warning that is treated as an error. If you still want to proceed, you could comment out this line: https://github.com/NSLS-II/edrixs/blob/31f82573510ddfbc8424be13d4f79cac103364c3/docs/Makefile#L5
That's the error:
Warning, treated as error:
/home/runner/work/edrixs/edrixs/docs/source/user/quickstart.rst:5:undefined label: 'sphx_glr_auto_examples'
make: *** [Makefile:20: html] Error 2
make: Leaving directory '/home/runner/work/edrixs/edrixs/docs'
Looks like the label sphx_glr_auto_examples
has to be defined. Is it supposed to point to another document?
I was wondering what was going on with the docs build.
I believe the warning comes from the sphinx underline being longer than the title like this
Notes
-------
and had in mind that the warning and the build overall would be fixed if i changed this?
I believe the warning comes from the sphinx underline being longer than the title like this
Notes -------
That can be fixed too, but I don't think it's a problem, as other people used very long underlines for short titles. Per https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections, it cannot be shorter than a title.
https://github.com/sphinx-gallery/sphinx-gallery/issues/734 has a discussion and potential solutions to a similar issue.
I looked at the issues section of sphinx gallery following your suggestion.
If I get the links as
python -m sphinx.ext.intersphinx docs/build/html/objects.inv > links.txt
There does seem to be an entry sphx_glr_auto_examples
so the problem is not transparent to me.
I think I'll just remove the line converting warnings to errors.
This updates the docs in light of moving the build to conda-forge.