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

Cannot build the docs with latest sphinx 3.1.1. #1368

Closed
hvy opened this issue Jun 15, 2020 · 2 comments · Fixed by #1393
Closed

Cannot build the docs with latest sphinx 3.1.1. #1368

hvy opened this issue Jun 15, 2020 · 2 comments · Fixed by #1393
Labels
bug Issue/PR about behavior that is broken. Not for typos/examples/CI/test but for Optuna itself.

Comments

@hvy
Copy link
Member

hvy commented Jun 15, 2020

Expected behavior

Docs should be built properly without warnings/errors. Following warnings are raised by sphinx's latests release 3.1.1.

Environment

  • sphinx==3.1.1

Error messages, stack traces, or logs

WARNING: Failed to update signature for <function MLflowCallback.__init__ at 0x7feea1b4e280>: parameter not found: 'args'
 
WARNING: Failed to update signature for <function GridSampler.__init__ at 0x7feeabb5edc0>: parameter not found: 'args'
 
WARNING: Failed to update signature for <function RedisStorage.__init__ at 0x7feeabb4ce50>: parameter not found: 'args'
 
WARNING: Failed to update signature for <function Study.enqueue_trial at 0x7feeabb4ec10>: parameter not found: 'kwargs'

Steps to reproduce

  1. pip install sphinx -U
  2. cd docs
  3. make clean
  4. make html
@hvy hvy added the bug Issue/PR about behavior that is broken. Not for typos/examples/CI/test but for Optuna itself. label Jun 15, 2020
@crcrpar
Copy link
Contributor

crcrpar commented Jun 19, 2020

Could you tell us the status of this issue?
Do we still see this problem? Do you just forget to close?

@hvy
Copy link
Member Author

hvy commented Jun 19, 2020

It's still an issue in the sense that we cannot build the docs with 3.1.1. We could close this issue however if we make sure to support future releases of sphinx.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue/PR about behavior that is broken. Not for typos/examples/CI/test but for Optuna itself.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants