ladsantos / p-winds

Python implementation of Parker wind models for exoplanet atmospheres
https://p-winds.readthedocs.io/
MIT License
10 stars 5 forks source link

Documentation rendering: docstring formatting not as intended #39

Closed gully closed 1 year ago

gully commented 1 year ago

Hi! 👋 Great package here 🙏

I noticed a teeny-tiny rendering issue on the documentation page.

The dtype information does not appear to render as Monospace as intended in the Parameters docstring. The double backticks remain as plain text backticks:

image

I was able to make the Monospace font render as intended by :

  1. swapping the order of the colon from the end:
    temperature (``float``):

    to the colon in between the two text fields:

    temperature : ``float``

    and,

  2. Upgrading to a recent sphinx_rtd_theme=1.2.0 from the previous default on my system 0.4.3
image
ladsantos commented 1 year ago

Issue is fixed in 613c38d.