Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Readthedocs uses Sphinx 3.1.0 and experimental functions and classes show incorrect signature

See original GitHub issue

Example

Screen Shot 2020-06-11 at 10 32 03

https://optuna.readthedocs.io/en/latest/reference/visualization.html#optuna.visualization.plot_param_importances

Log on Readthedocs

Screen Shot 2020-06-11 at 10 44 57

https://readthedocs.org/projects/optuna/builds/11227856/

How to fix

Fix docs/requirements.txt should solve this issue.

Issue Analytics

State:
Created 3 years ago
Reactions:1
Comments:6 (6 by maintainers)

Top GitHub Comments

3reactions

harupycommented, Jun 11, 2020

Verified the second approach works on my forked repo.

0reactions

toshihikoyanasecommented, Jun 11, 2020

@harupy Thank you for your investigation. I didn’t know that Sphinx uses it. I think it’s reasonable to take the second approach that allows us to integrate the document dependencies into setup.py.

Top Results From Across the Web

Sphinx Documentation - Read the Docs

First steps to document your project using Sphinx . ... was out of sync with the code itself, since the function signature was...

Changelog - Sphinx documentation

#10421: autodoc: autodoc_preserve_defaults doesn't work on class methods ... #9908: autodoc: debug message is shown on building document using NewTypes with ...

Sphinx AutoAPI Documentation - Read the Docs

__foo__ in Python). • show-inheritance: Display a list of base classes below the class signature. • show-inheritance-diagram: Display an ...

sphinx-js - PyPI

Support for using Sphinx on JSDoc-documented JS code.

sphinx Changelog - pyup.io

Fix using ``sphinx.ext.autosummary`` with modules containing titles in the ... 8105: autodoc: the signature of class constructor will be shown for decorated