search

emsig / empymod

Full 3D electromagnetic modeller for 1D VTI media
https://empymod.emsig.xyz
Apache License 2.0
85 stars 22 forks source link

Rendering bug in API doc #115

Closed halbmy closed 3 years ago

halbmy commented 3 years ago

The docstrings in the API docs, e.g. https://empymod.readthedocs.io/en/stable/modeller.html#empymod.model.bipole are erroneously rendered, probably due to some sphinx (or sphinxcontrib) upgrade so that the type is merged to the variable names: image

prisae commented 3 years ago

Thanks @halbmy for reporting, indeed!

I'll have to figure out what the reason is. v2.0.2 seems still to be fine (https://empymod.readthedocs.io/en/v2.0.2), after that it has this error.

It was a long-standing issue with the numpydoc theme and sphinx versions, but I thought it was resolved... oh well.

prisae commented 3 years ago

Hm. Locally I don't have it, and on emg3d.readthedocs.io it isn't an issue either, strange.

prisae commented 3 years ago

https://github.com/numpy/numpydoc/issues/215

prisae commented 3 years ago

This will be fixed by #116

I have to force RTD to install sphinx_rtd_theme>=0.5.0. I don't know why RTD uses such outdated versions by default (e.g., sphinx<2.

I should probably move to create the docs with CI and host on the own website instead of RTD... One day in the future.

Thanks again @halbmy !

prisae commented 3 years ago

It will not fix stable, as this is a release, but latest (and the next stable, whenever that will happen...):

https://empymod.readthedocs.io/en/latest/modeller.html#empymod.model.bipole