search

jbms / sphinx-immaterial

Adaptation of the popular mkdocs-material material design theme to the sphinx documentation system
https://jbms.github.io/sphinx-immaterial/
Other
196 stars 29 forks source link

Fields render differently between RTD and GH Pages #156

Closed mhostetter closed 2 years ago

mhostetter commented 2 years ago

Just an observation... I'm not sure which is preferable. Just mentioning because I'm surprised they can be different at all. I noticed this after building my docs with GitHub Pages. And then I noticed that this theme's docs display the same way.

GitHub Pages

https://jbms.github.io/sphinx-immaterial/python_apigen_generated/bar.html

image

Read the Docs

https://sphinx-immaterial.readthedocs.io/en/latest/python_apigen_generated/bar.html

image

jbms commented 2 years ago

This appears to be due to a difference in the docutils version in use.

The addition of the colon was due to:

https://repo.or.cz/docutils.git/commit/dccf9c42d03e8e4a7c285c29fcce4ae90d7a0b6c

I'm not sure whether the colon is desirable or not, but if it is present, it should occur before the headerlink (which this theme adds via monkey patch).