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

Fix docstrings being rendered incorrectly in API documentation #1154

Closed
jaladh-singhal opened this issue May 19, 2020 · 1 comment · Fixed by #1369
Closed

Fix docstrings being rendered incorrectly in API documentation #1154

jaladh-singhal opened this issue May 19, 2020 · 1 comment · Fixed by #1369

Comments

@jaladh-singhal
Copy link
Member

jaladh-singhal commented May 19, 2020

Some of the docstrings in tardis API documentation are being rendered incorrectly as in tardis.util.base where parameter name and type appears to be merged in html (e.g. atomic_numberint), despite it is separated by colon in docstrings (atomic_number: int).

Also there's some problem in latex equation in intensity_black_body due to which it is getting line-breaked in html.

Some Pointers

  • It might have something to do with sphinx config.py file or rtd-theme settings
  • Find out all other submodules or modules which have such or related problems and fix them.
@jaladh-singhal
Copy link
Member Author

@arjunsavel regarding the 1st part where parameter name and type gets merged - that was due to some CSS bug as mentioned in numpydoc#215 and has been fixed by latest update of sphinx_rtd_theme to 0.5.0 (released 8-9 hrs ago on conda-forge) - I've tested this locally for my widgets module api docs and it works.

Since we have sphinx_rtd_theme unpinned - it should work next time docs-pipeline builds docs (or if you've rights you can manually trigger the pipeline to see it now).

But for 2nd part about latex equation - the equation is still line-breaked with this update, so most probably it is a latex error IMO.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant