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

Standard in docs and bug in Sphinx #178

Closed
zssherman opened this issue Jan 22, 2020 · 2 comments
Closed

Standard in docs and bug in Sphinx #178

zssherman opened this issue Jan 22, 2020 · 2 comments

Comments

@zssherman
Copy link
Collaborator

So I was converting over Py-ARTs docs and ran into something from ACT early on. I remember we had the docs set where parameters had a space on both side of the colon before the parameter type. This is inline with doc styles for major packages. When it stopped working the spaces were removed. It turned out this was an update sphinx did that messed with numpy docs:
readthedocs/sphinx_rtd_theme#766 (comment)

The fixed mentioned, however, will fix rtd theme but then centers all tables for parameters which looks ugly, in my opinion.

A way around all these and looks cleaner both standard wise and in the documentation itself is to remove numpy doc and have the sphinx napolean extension and revert to having the space before and after the colon in the docs to keep with standards. I can do a pull request soon if you all wish.

@AdamTheisen
Copy link
Collaborator

@zssherman thanks for catching that. I thought it was odd when that issue came up. If you think that will make the docs look better and @rcjackson doesn't see any issues with it, go right on ahead.

@AdamTheisen
Copy link
Collaborator

#180 resolved this

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

No branches or pull requests

2 participants