search

astropy / sphinx-automodapi

Sphinx extension for generating API documentation
https://sphinx-automodapi.readthedocs.io
BSD 3-Clause "New" or "Revised" License
65 stars 45 forks source link

autosummary causes bad linking on Windows #41

Closed pllim closed 5 years ago

pllim commented 6 years ago

I attempted to build docs for astropy v3.1dev on Windows and got over 3000 warnings like this:

<autosummary>:: WARNING: toctree contains reference to nonexisting document 'wcs/..\\api/astropy.wcs.utils.custom_frame_to_wcs_mappings'

Not just wcs is affected, which led me to believe that the bug is upstream over here.

astrofrog commented 6 years ago

Looks like a mix of / and \ - we do run tests on AppVeyor here but it's possible there are some corner cases that don't work right on Windows.

pllim commented 5 years ago

Update: Still an issue with 3.2.dev23734

build succeeded, 4284 warnings.
astrofrog commented 5 years ago

I think what we need to do is come up with a minimal example and include it in the CI here. Do you see this on simpler packages than astropy?

astrofrog commented 5 years ago

I think it's actually a simple problem - testing a hypothesis in https://github.com/astropy/sphinx-automodapi/pull/63

astrofrog commented 5 years ago

This is fixed by https://github.com/astropy/sphinx-automodapi/pull/63 - there are still some warnings in the astropy docs build (mainly related to references) but that's unrelated.

astrofrog commented 5 years ago

@pllim - I think I know how to solve the remaining warnings. More soon.

astrofrog commented 5 years ago

@pllim - I've now fixed most of the remaining warnings. Can you confirm that there are no more warnings with the latest developer version of sphinx-automodapi?

pllim commented 5 years ago

I'll report back when I get a chance. Thank you so much!

pllim commented 5 years ago

I can confirm that with the patch in master, I only get 10 warnings now and they are nothing new (Matplotlib FutureWarning and such). Thank you!