-
Notifications
You must be signed in to change notification settings - Fork 915
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 references in inherited docstrings make documentation fail #2453
Labels
Component: Documentation 📄
Issue/PR for markdown and API documentation
Issue: Bug Report 🐞
Bug that needs to be fixed
Comments
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 a commit
that referenced
this issue
Mar 22, 2023
"Temporary" (hopefully) workaround for gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
All the way down... |
astrojuanlu
added a commit
that referenced
this issue
Mar 22, 2023
* Do not initialize Mermaid JS Fix gh-2451. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Allow warnings in documentation "Temporary" (hopefully) workaround for gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> --------- Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
It was #2353 |
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
Also appearing now in gh-2421 and gh-2459:
I can reproduce this in current |
And I'm quite sure the second set of messages come from sphinx-doc/sphinx#9884, which is unfortunately open |
astrojuanlu
added a commit
that referenced
this issue
Mar 23, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 23, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 23, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 23, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
This comment was marked as resolved.
This comment was marked as resolved.
astrojuanlu
added a commit
that referenced
this issue
Mar 23, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 23, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 23, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 23, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 23, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 28, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 28, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 28, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 28, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 28, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 28, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 28, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 28, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
jmholzer
pushed a commit
that referenced
this issue
Mar 29, 2023
* Do not initialize Mermaid JS Fix gh-2451. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Allow warnings in documentation "Temporary" (hopefully) workaround for gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> --------- Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 30, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 30, 2023
See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
astrojuanlu
added a commit
that referenced
this issue
Mar 30, 2023
* Remove unused docs/package.json Nowadays sphinx-autobuild offers similar functionality. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix Sphinx language config Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix circular imports Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Remove unused documentation extensions Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Try to not move files around Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix CSS paths Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix file hierarchy Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix Read the Docs configuration Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Update documentation dependencies Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Manually fix JupyterCommandGroup API docs See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Install all documentation dependencies Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Restore test requirements kedro.extras.datasets is still being tested. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Remove all autosummary members from problematic class See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Temporarily disable nitpicky mode for linkcheck Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Upgrade Read the Docs to Python 3.8 Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix destination of linkcheck Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Minor fixes to docstrings Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Minor reference fix Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Cap sphinx-autodoc-typehints version Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Restore nitpicky linkcheck Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Restore treating documentation warnings as errors Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Remove redundant build-docs CI job Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Ignore .rst files generated to support docs build Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> * Explain ignored documentation files Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Move linkcheck to Read the Docs Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Remove old devserver Makefile target Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix databricks broken reference Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix pyspark broken reference Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix other broken references Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> --------- Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
jmholzer
pushed a commit
that referenced
this issue
Mar 30, 2023
* Remove unused docs/package.json Nowadays sphinx-autobuild offers similar functionality. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix Sphinx language config Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix circular imports Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Remove unused documentation extensions Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Try to not move files around Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix CSS paths Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix file hierarchy Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix Read the Docs configuration Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Update documentation dependencies Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Manually fix JupyterCommandGroup API docs See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Install all documentation dependencies Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Restore test requirements kedro.extras.datasets is still being tested. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Remove all autosummary members from problematic class See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Temporarily disable nitpicky mode for linkcheck Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Upgrade Read the Docs to Python 3.8 Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix destination of linkcheck Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Minor fixes to docstrings Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Minor reference fix Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Cap sphinx-autodoc-typehints version Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Restore nitpicky linkcheck Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Restore treating documentation warnings as errors Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Remove redundant build-docs CI job Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Ignore .rst files generated to support docs build Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> * Explain ignored documentation files Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Move linkcheck to Read the Docs Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Remove old devserver Makefile target Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix databricks broken reference Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix pyspark broken reference Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix other broken references Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> --------- Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Jannic Holzer <jannic.holzer@quantumblack.com>
jmholzer
pushed a commit
that referenced
this issue
Mar 30, 2023
* Remove unused docs/package.json Nowadays sphinx-autobuild offers similar functionality. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix Sphinx language config Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix circular imports Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Remove unused documentation extensions Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Try to not move files around Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix CSS paths Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix file hierarchy Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix Read the Docs configuration Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Update documentation dependencies Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Manually fix JupyterCommandGroup API docs See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Install all documentation dependencies Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Restore test requirements kedro.extras.datasets is still being tested. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Remove all autosummary members from problematic class See gh-2453. Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Temporarily disable nitpicky mode for linkcheck Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Upgrade Read the Docs to Python 3.8 Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix destination of linkcheck Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Minor fixes to docstrings Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Minor reference fix Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Cap sphinx-autodoc-typehints version Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Restore nitpicky linkcheck Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Restore treating documentation warnings as errors Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Remove redundant build-docs CI job Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Ignore .rst files generated to support docs build Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> * Explain ignored documentation files Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Move linkcheck to Read the Docs Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Remove old devserver Makefile target Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix databricks broken reference Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix pyspark broken reference Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Fix other broken references Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> --------- Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Addressed in gh-2459. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Component: Documentation 📄
Issue/PR for markdown and API documentation
Issue: Bug Report 🐞
Bug that needs to be fixed
Now docs are failing because of something else:
(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: