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

Missing documentation for dateutil, numpy, and pandas extras #1326

Closed
Zac-HD opened this issue Jun 13, 2018 · 1 comment
Closed

Missing documentation for dateutil, numpy, and pandas extras #1326

Zac-HD opened this issue Jun 13, 2018 · 1 comment
Assignees
Labels
docs documentation could *always* be better

Comments

@Zac-HD
Copy link
Member

Zac-HD commented Jun 13, 2018

See here. I suspect that this is something to do with the automodule Sphinx directive. We should:

  1. Fix this. Obviously, missing documentation is bad.
  2. Work out how to test that it doesn't happen again (in the simple case, check that the fully-qualified names appear in the generated pages). This is optional, if we decide to go for (3) directly.
  3. Get upstream (ie Sphinx) to add a warning, which is emitted when autowhatever directives produce no output. This would be generally useful, and turn into an error under our CI.
@Zac-HD Zac-HD added the docs documentation could *always* be better label Jun 13, 2018
@Zac-HD
Copy link
Member Author

Zac-HD commented Jun 21, 2018

Works on my machine - ie docs are produced as expected - which is going to make debugging "fun".

#1250 might help, or at least listing the correct things to document can't hurt.

I still have no idea of the root cause, but decorators are a perennial issue, as are things imported from another module, and imported decorators are especially bad for Sphinx. Could be that? (except it does work on my machine!) Missing docstring for extra.numpy.boolean_dtypes certainly doesn't help either.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation could *always* be better
Projects
None yet
Development

No branches or pull requests

1 participant