Missing references in inherited docstrings make documentation fail #2453

astrojuanlu · 2023-03-22T11:28:44Z

Now docs are failing because of something else:

WARNING: Cannot resolve forward reference in type annotations of "kedro.framework.cli.jupyter.JupyterCommandGroup.shell_complete": name 'CompletionItem' is not defined
WARNING: Cannot resolve forward reference in type annotations of "kedro.framework.cli.jupyter.JupyterCommandGroup.shell_complete": name 'CompletionItem' is not defined

(see gh-2452, gh-2450)

I noticed this locally yesterday but I thought it was because I was breaking havoc.

It's unclear what changed here because we didn't touch anything and there haven't been click releases recently.

The text was updated successfully, but these errors were encountered:

"Temporary" (hopefully) workaround for gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

stichbury · 2023-03-22T11:53:17Z

All the way down...
🐢
🐢
🐢

* Do not initialize Mermaid JS Fix gh-2451. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Allow warnings in documentation "Temporary" (hopefully) workaround for gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> --------- Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu · 2023-03-22T12:32:58Z

It was #2353

astrojuanlu · 2023-03-23T08:26:26Z

Also appearing now in gh-2421 and gh-2459:

/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Group.add_command:1:<autosummary>:1: WARNING: py:class reference target not found: Command
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Group.add_command:1:<autosummary>:1: WARNING: py:class reference target not found: Command
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Group.add_command:1:<autosummary>:1: WARNING: py:class reference target not found: click.core.Parameter
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Group.add_command:1:<autosummary>:1: WARNING: py:class reference target not found: Context
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Group.add_command:1:<autosummary>:1: WARNING: py:class reference target not found: click.core.Command
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Group.add_command:1: WARNING: py:class reference target not found: Command
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Group.command:16: WARNING: py:class reference target not found: click.core.Command
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Group.command:16: WARNING: py:class reference target not found: click.core.Command
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of kedro.framework.cli.jupyter.JupyterCommandGroup.command_class:: WARNING: py:class reference target not found: click.core.Command
<unknown>:1: WARNING: py:class reference target not found: click.core.Context
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Group.get_command:1: WARNING: py:class reference target not found: Command
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Group.get_command:5: WARNING: py:class reference target not found: click.core.Command
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Command.get_help_option:4: WARNING: py:class reference target not found: click.core.Option
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Command.get_params:2: WARNING: py:class reference target not found: click.core.Parameter
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Group.group:16: WARNING: py:class reference target not found: click.core.Group
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Group.group:16: WARNING: py:class reference target not found: click.core.Group
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of kedro.framework.cli.jupyter.JupyterCommandGroup.group_class:: WARNING: py:class reference target not found: Group
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.BaseCommand.main:6: WARNING: py:class reference target not found: Command
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.BaseCommand.main:35: WARNING: py:class reference target not found: Context
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.BaseCommand.make_context:1: WARNING: py:class reference target not found: Context
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.BaseCommand.make_context:16: WARNING: py:class reference target not found: click.core.Context
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.BaseCommand.make_context:26: WARNING: py:class reference target not found: click.core.Context
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.Command.make_parser:4: WARNING: py:class reference target not found: click.parser.OptionParser
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.MultiCommand.resolve_command:2: WARNING: py:class reference target not found: click.core.Command
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.MultiCommand.shell_complete:5: WARNING: py:class reference target not found: click.core.Context
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.MultiCommand.to_info_dict:5: WARNING: py:meth reference target not found: click.Context.to_info_dict
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.MultiCommand.to_info_dict:8: WARNING: py:class reference target not found: click.core.Context
/home/circleci/project/kedro/framework/cli/jupyter.py:docstring of click.core.MultiCommand.to_info_dict:9: WARNING: py:class reference target not found: Context

I can reproduce this in current main.

astrojuanlu · 2023-03-23T11:38:49Z

The "forward reference" errors come from https://github.com/tox-dev/sphinx-autodoc-typehints, see https://github.com/tox-dev/sphinx-autodoc-typehints/blob/4f275f5a1af467bd708df82a4d5ec4064dac3779/src/sphinx_autodoc_typehints/__init__.py#L384-L398

astrojuanlu · 2023-03-23T11:52:24Z

And I'm quite sure the second set of messages come from sphinx-doc/sphinx#9884, which is unfortunately open

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

* Do not initialize Mermaid JS Fix gh-2451. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Allow warnings in documentation "Temporary" (hopefully) workaround for gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> --------- Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> Signed-off-by: Jannic Holzer <[email protected]>

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

* Remove unused docs/package.json Nowadays sphinx-autobuild offers similar functionality. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix Sphinx language config Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix circular imports Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Remove unused documentation extensions Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Try to not move files around Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix CSS paths Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix file hierarchy Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix Read the Docs configuration Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Update documentation dependencies Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Manually fix JupyterCommandGroup API docs See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Install all documentation dependencies Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Restore test requirements kedro.extras.datasets is still being tested. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Remove all autosummary members from problematic class See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Temporarily disable nitpicky mode for linkcheck Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Upgrade Read the Docs to Python 3.8 Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix destination of linkcheck Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Minor fixes to docstrings Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Minor reference fix Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Cap sphinx-autodoc-typehints version Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Restore nitpicky linkcheck Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Restore treating documentation warnings as errors Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Remove redundant build-docs CI job Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Ignore .rst files generated to support docs build Signed-off-by: Jo Stichbury <[email protected]> * Explain ignored documentation files Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Move linkcheck to Read the Docs Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Remove old devserver Makefile target Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix databricks broken reference Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix pyspark broken reference Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix other broken references Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> --------- Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> Signed-off-by: Jo Stichbury <[email protected]> Co-authored-by: Jo Stichbury <[email protected]>

* Remove unused docs/package.json Nowadays sphinx-autobuild offers similar functionality. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix Sphinx language config Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix circular imports Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Remove unused documentation extensions Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Try to not move files around Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix CSS paths Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix file hierarchy Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix Read the Docs configuration Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Update documentation dependencies Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Manually fix JupyterCommandGroup API docs See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Install all documentation dependencies Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Restore test requirements kedro.extras.datasets is still being tested. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Remove all autosummary members from problematic class See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Temporarily disable nitpicky mode for linkcheck Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Upgrade Read the Docs to Python 3.8 Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix destination of linkcheck Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Minor fixes to docstrings Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Minor reference fix Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Cap sphinx-autodoc-typehints version Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Restore nitpicky linkcheck Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Restore treating documentation warnings as errors Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Remove redundant build-docs CI job Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Ignore .rst files generated to support docs build Signed-off-by: Jo Stichbury <[email protected]> * Explain ignored documentation files Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Move linkcheck to Read the Docs Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Remove old devserver Makefile target Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix databricks broken reference Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix pyspark broken reference Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix other broken references Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> --------- Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> Signed-off-by: Jo Stichbury <[email protected]> Co-authored-by: Jo Stichbury <[email protected]> Signed-off-by: Jannic Holzer <[email protected]>

* Remove unused docs/package.json Nowadays sphinx-autobuild offers similar functionality. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix Sphinx language config Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix circular imports Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Remove unused documentation extensions Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Try to not move files around Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix CSS paths Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix file hierarchy Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix Read the Docs configuration Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Update documentation dependencies Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Manually fix JupyterCommandGroup API docs See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Install all documentation dependencies Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Restore test requirements kedro.extras.datasets is still being tested. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Remove all autosummary members from problematic class See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Temporarily disable nitpicky mode for linkcheck Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Upgrade Read the Docs to Python 3.8 Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix destination of linkcheck Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Minor fixes to docstrings Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Minor reference fix Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Cap sphinx-autodoc-typehints version Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Restore nitpicky linkcheck Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Restore treating documentation warnings as errors Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Remove redundant build-docs CI job Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Ignore .rst files generated to support docs build Signed-off-by: Jo Stichbury <[email protected]> * Explain ignored documentation files Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Move linkcheck to Read the Docs Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Remove old devserver Makefile target Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix databricks broken reference Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix pyspark broken reference Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Fix other broken references Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> --------- Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> Signed-off-by: Jo Stichbury <[email protected]> Co-authored-by: Jo Stichbury <[email protected]>

astrojuanlu · 2023-03-31T10:35:09Z

Addressed in gh-2459.

astrojuanlu added Component: Documentation 📄 Issue/PR for markdown and API documentation Issue: Bug Report 🐞 Bug that needs to be fixed labels Mar 22, 2023

astrojuanlu added this to Kedro Framework Mar 22, 2023

astrojuanlu added a commit that referenced this issue Mar 22, 2023

Allow warnings in documentation

add76ff

"Temporary" (hopefully) workaround for gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu mentioned this issue Mar 22, 2023

Do not initialize Mermaid JS #2452

Merged

5 tasks

astrojuanlu mentioned this issue Mar 22, 2023

Revamp and simplify Sphinx documentation process #2454

Closed

astrojuanlu mentioned this issue Mar 22, 2023

Initial Sphinx revamp #2459

Merged

5 tasks

astrojuanlu changed the title ~~"Cannot resolve forward reference in type annotations" makes documentation fail~~ Missing references in inherited docstrings make documentation fail Mar 23, 2023

astrojuanlu moved this to In Progress in Kedro Framework Mar 23, 2023

astrojuanlu self-assigned this Mar 23, 2023

astrojuanlu added a commit that referenced this issue Mar 23, 2023

Manually fix JupyterCommandGroup API docs

c5dc172

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 23, 2023

Manually fix JupyterCommandGroup API docs

1802df0

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 23, 2023

Manually fix JupyterCommandGroup API docs

d868a95

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 23, 2023

Manually fix JupyterCommandGroup API docs

41b7ab0

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

This comment was marked as resolved.

Sign in to view

astrojuanlu added a commit that referenced this issue Mar 23, 2023

Remove all autosummary members from problematic class

ba4425e

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 23, 2023

Manually fix JupyterCommandGroup API docs

5594eb1

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 23, 2023

Remove all autosummary members from problematic class

ac17192

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 23, 2023

Manually fix JupyterCommandGroup API docs

5326602

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 23, 2023

Remove all autosummary members from problematic class

30f94ba

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 28, 2023

Manually fix JupyterCommandGroup API docs

16c0af5

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 28, 2023

Remove all autosummary members from problematic class

68fc257

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 28, 2023

Manually fix JupyterCommandGroup API docs

b759967

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 28, 2023

Remove all autosummary members from problematic class

386490e

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 28, 2023

Manually fix JupyterCommandGroup API docs

a4001d5

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 28, 2023

Remove all autosummary members from problematic class

5e18518

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 28, 2023

Manually fix JupyterCommandGroup API docs

d9a3f11

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 28, 2023

Remove all autosummary members from problematic class

c0d5673

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 30, 2023

Manually fix JupyterCommandGroup API docs

4e80721

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu added a commit that referenced this issue Mar 30, 2023

Remove all autosummary members from problematic class

577006d

See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <[email protected]>

astrojuanlu closed this as completed Mar 31, 2023

github-project-automation bot moved this from In Progress to Done in Kedro Framework Mar 31, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Missing references in inherited docstrings make documentation fail #2453

Missing references in inherited docstrings make documentation fail #2453

astrojuanlu commented Mar 22, 2023

stichbury commented Mar 22, 2023

astrojuanlu commented Mar 22, 2023

astrojuanlu commented Mar 23, 2023

astrojuanlu commented Mar 23, 2023

astrojuanlu commented Mar 23, 2023

This comment was marked as resolved.

astrojuanlu commented Mar 31, 2023

Missing references in inherited docstrings make documentation fail #2453

Missing references in inherited docstrings make documentation fail #2453

Comments

astrojuanlu commented Mar 22, 2023

stichbury commented Mar 22, 2023

astrojuanlu commented Mar 22, 2023

astrojuanlu commented Mar 23, 2023

astrojuanlu commented Mar 23, 2023

astrojuanlu commented Mar 23, 2023

This comment was marked as resolved.

astrojuanlu commented Mar 31, 2023