Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fields render differently between RTD and GH Pages #156

Closed
mhostetter opened this issue Aug 30, 2022 · 1 comment · Fixed by #157
Closed

Fields render differently between RTD and GH Pages #156

mhostetter opened this issue Aug 30, 2022 · 1 comment · Fixed by #157

Comments

@mhostetter
Copy link
Contributor

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
Copy link
Owner

jbms commented Aug 30, 2022

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).

jbms added a commit that referenced this issue Aug 31, 2022
Fixes #156.

This also refactors the various HTMLTranslator overrides.
jbms added a commit that referenced this issue Aug 31, 2022
Fixes #156.

This also refactors the various HTMLTranslator overrides.
@jbms jbms closed this as completed in #157 Aug 31, 2022
jbms added a commit that referenced this issue Aug 31, 2022
Fixes #156.

This also refactors the various HTMLTranslator overrides.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants