-
Notifications
You must be signed in to change notification settings - Fork 89
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
ci: Add docs rtd check on kedro-datasets
#299
Conversation
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
kedro-datasets
kedro-datasets
kedro-datasets
kedro-datasets
kedro-datasets
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Hi @merelcht I am sorry I wasn't more clued in to what you were working on with this as we could have discussed in advance what the overall plan is...which is indeed to move the docs into a RTD subproject per kedro-org/kedro#2600 (which means moving the docs into this repo, creating a new subproject on RTD etc.). I think what you've done is fine but probably it doesn't go far enough to meet that subproject goal, although I'm still not totally clear because I can't see the RTD subproject (if you've created it, please could you add me as admin https://readthedocs.org/profiles/stichbury/ ? |
My approach now doesn't move the docs into a RTD subproject. Instead I went for a quick fix approach to make sure that for the coming releases we don't get blocked again by syntax problems in I'd suggest getting this in temporarily but then when the RTD subproject has been setup properly remove this build step again. I assumed that the RTD setup will take more time and I wanted to fix this blocker quickly 😄 |
Setting up RTD might actually take less 😄 in any case, the initial work of doing I'd take care of this myself but I don't have permissions. Will try to review the current approach locally in the meantime. |
What do you need permission for? Maybe I can grant it 😃 |
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I gave this a quick try locally, found this error after installing the dependencies:
$ cd kedro-datasets/docs && sphinx-build -WETan -j auto -D language=en -b linkcheck -d _build/doctrees source _build/linkcheck
[...looooong list of DeprecationWarning...]
[08/14/23 13:30:16] WARNING /Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/ warnings.py:109
site-packages/kedro_datasets/yaml/yaml_dataset.py:10:
DeprecationWarning: 'DataSetError' has been renamed to
'DatasetError', and the alias will be removed in Kedro 0.19.0
from kedro.io.core import (
Traceback (most recent call last):
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/ext/autosummary/generate.py", line 395, in generate_autosummary_docs
name, obj, parent, modname = import_by_name(entry.name)
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/ext/autosummary/__init__.py", line 661, in import_by_name
raise ImportExceptionGroup('no module named %s' % ' or '.join(tried), exceptions)
sphinx.ext.autosummary.ImportExceptionGroup: no module named kedro_datasets.pandas.DeltaTableDataSet
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/ext/autosummary/generate.py", line 400, in generate_autosummary_docs
name, obj, parent, modname = import_ivar_by_name(entry.name)
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/ext/autosummary/__init__.py", line 732, in import_ivar_by_name
raise ImportError
ImportError
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/cmd/build.py", line 276, in build_main
app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/application.py", line 262, in __init__
self._init_builder()
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/application.py", line 335, in _init_builder
self.events.emit('builder-inited')
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/events.py", line 94, in emit
results.append(listener.handler(self.app, *args))
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/ext/autosummary/__init__.py", line 811, in process_generate_options
generate_autosummary_docs(genfiles, suffix=suffix, base_path=app.srcdir,
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/ext/autosummary/generate.py", line 409, in generate_autosummary_docs
logger.warning(__('[autosummary] failed to import %s.\nPossible hints:\n%s'),
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 1847, in warning
self.log(WARNING, msg, *args, **kwargs)
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/util/logging.py", line 123, in log
super().log(level, msg, *args, **kwargs)
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 1879, in log
self.logger.log(level, msg, *args, **kwargs)
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 1547, in log
self._log(level, msg, args, **kwargs)
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 1624, in _log
self.handle(record)
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 1634, in handle
self.callHandlers(record)
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 1696, in callHandlers
hdlr.handle(record)
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 964, in handle
rv = self.filter(record)
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/logging/__init__.py", line 821, in filter
result = f.filter(record)
File "/Users/juan_cano/.micromamba/envs/kedro310-dev/lib/python3.10/site-packages/sphinx/util/logging.py", line 426, in filter
raise exc
sphinx.errors.SphinxWarning: [autosummary] failed to import kedro_datasets.pandas.DeltaTableDataSet.
Possible hints:
* ImportError:
* ModuleNotFoundError: No module named 'kedro_datasets.pandas.DeltaTableDataSet'
* AttributeError: module 'kedro_datasets.pandas' has no attribute 'DeltaTableDataSet'
Warning, treated as error:
[autosummary] failed to import kedro_datasets.pandas.DeltaTableDataSet.
Possible hints:
* ImportError:
* ModuleNotFoundError: No module named 'kedro_datasets.pandas.DeltaTableDataSet'
* AttributeError: module 'kedro_datasets.pandas' has no attribute 'DeltaTableDataSet'
This is probably related to kedro-org/kedro#2871 (comment), we never opened an issue on this side I think.
After I did pip install ./kedro-datasets[all,pandas-deltatabledataset]
, I tried again and complained about kedro_datasets.snowflake.SnowparkTableDataSet
.
This comment was marked as resolved.
This comment was marked as resolved.
For the record, the |
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>
d1315c2
to
d2d2350
Compare
Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
73ce53a
to
0b432b2
Compare
RTD builds are on now: https://readthedocs.org/projects/kedro-plugins/builds/21606215/ |
Aaaaand it worked! https://kedro-plugins--299.org.readthedocs.build/en/299/kedro_datasets.html |
Both your links return 404 for me @astrojuanlu 🤔 But I can see the checks passed! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to approve this. Thanks @merelcht!
I requested a rename and it happened overnight, now it's https://readthedocs.org/projects/kedro-datasets/builds/21613210/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
What's the two different RTD build? One is giving me 404 error. |
Project URL changed from kedro-plugins to kedro-datasets |
* Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com>
* Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com>
* Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com>
…#303) * feat: move default mode of ManagedTableDataSet to read-only default of `write_mode` is None preventing `save` by default Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix(datasets): Correct pyproject.toml syntax for optional dependencies (#302) * Fix pyproject.toml syntax for optional dependencies Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> * refacor out the base dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * add comments Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * format pyproject.toml Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * Reorder pandas dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * reorder spark dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * remove polars-base and delta-base Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * Update kedro-datasets/kedro_datasets/databricks/managed_table_dataset.py Co-authored-by: Joel <35801847+datajoely@users.noreply.github.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * added entry to RELEASE.md Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * docs: Fix broken link to datasets docs in README.md (#304) fix broken link to datasets docs Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * ci: Add docs rtd check on `kedro-datasets` (#299) * Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * update docstring Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * Merge branch 'main' into managed-table-dataset-read-only-by-default Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> --------- Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Co-authored-by: Dmitry Sorokin <40151847+DimedS@users.noreply.github.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Joel <35801847+datajoely@users.noreply.github.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com>
* Add CONTRIBUTING.md file to the Kedro-Plugins repository Signed-off-by: lrcouto <laurarccouto@gmail.com> * fix(datasets): Correct pyproject.toml syntax for optional dependencies (#302) * Fix pyproject.toml syntax for optional dependencies Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> * refacor out the base dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * add comments Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * format pyproject.toml Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * Reorder pandas dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * reorder spark dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * remove polars-base and delta-base Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * Bring CONTRIBUTING.md file in line with the one on the main Kedro repo Signed-off-by: lrcouto <laurarccouto@gmail.com> * Bring CONTRIBUTING.md file in line with the one on the main Kedro repo Signed-off-by: L. R. Couto <laurarccouto@gmail.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * docs: Fix broken link to datasets docs in README.md (#304) fix broken link to datasets docs Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * ci: Add docs rtd check on `kedro-datasets` (#299) * Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * fix(datasets): do not double encode the data as json when saving an A… (#301) * fix(datasets): do not double encode the data as json when saving an APIDataSet Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> * chore(lint): make pyling happy Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> --------- Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> Co-authored-by: Nok Lam Chan <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * build(datasets): release 1.5.2 (#305) * release 1.5.2 minor release to fix the kedro-datasets optional dependencies issue * Update RELEASE.md * Trim whitespace Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * Add plugin contribution details to CONTRIBUTING.md Signed-off-by: lrcouto <laurarccouto@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Update CONTRIBUTING.md Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Apply minor changes on CONTRIBUTING.md Signed-off-by: lrcouto <laurarccouto@gmail.com> * Push code of conduct text block to the top on CONTRIBUTING.md Signed-off-by: L. R. Couto <laurarccouto@gmail.com> * Fix trailing whitespace lint error Signed-off-by: L. R. Couto <laurarccouto@gmail.com> --------- Signed-off-by: lrcouto <laurarccouto@gmail.com> Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: L. R. Couto <laurarccouto@gmail.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> Co-authored-by: Dmitry Sorokin <40151847+DimedS@users.noreply.github.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com> Co-authored-by: Florian Gaudin-Delrieu <9217921+FlorianGD@users.noreply.github.com> Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
* Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
…kedro-org#303) * feat: move default mode of ManagedTableDataSet to read-only default of `write_mode` is None preventing `save` by default Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix(datasets): Correct pyproject.toml syntax for optional dependencies (kedro-org#302) * Fix pyproject.toml syntax for optional dependencies Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> * refacor out the base dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * add comments Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * format pyproject.toml Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * Reorder pandas dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * reorder spark dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * remove polars-base and delta-base Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * Update kedro-datasets/kedro_datasets/databricks/managed_table_dataset.py Co-authored-by: Joel <35801847+datajoely@users.noreply.github.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * added entry to RELEASE.md Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * docs: Fix broken link to datasets docs in README.md (kedro-org#304) fix broken link to datasets docs Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * ci: Add docs rtd check on `kedro-datasets` (kedro-org#299) * Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * update docstring Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * Merge branch 'main' into managed-table-dataset-read-only-by-default Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> * fix linting Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> --------- Signed-off-by: Flavien Lambert <PetitLepton@users.noreply.github.com> Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Co-authored-by: Dmitry Sorokin <40151847+DimedS@users.noreply.github.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Joel <35801847+datajoely@users.noreply.github.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com>
…-org#294) * Add CONTRIBUTING.md file to the Kedro-Plugins repository Signed-off-by: lrcouto <laurarccouto@gmail.com> * fix(datasets): Correct pyproject.toml syntax for optional dependencies (kedro-org#302) * Fix pyproject.toml syntax for optional dependencies Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> * refacor out the base dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * add comments Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * format pyproject.toml Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * Reorder pandas dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * reorder spark dependencies Signed-off-by: Nok <nok.lam.chan@quantumblack.com> * remove polars-base and delta-base Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * Bring CONTRIBUTING.md file in line with the one on the main Kedro repo Signed-off-by: lrcouto <laurarccouto@gmail.com> * Bring CONTRIBUTING.md file in line with the one on the main Kedro repo Signed-off-by: L. R. Couto <laurarccouto@gmail.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * docs: Fix broken link to datasets docs in README.md (kedro-org#304) fix broken link to datasets docs Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * ci: Add docs rtd check on `kedro-datasets` (kedro-org#299) * Try adding docs rtd check on kedro datasets Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com> * Add Read the Docs configuration for kedro-datasets Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * fix(datasets): do not double encode the data as json when saving an A… (kedro-org#301) * fix(datasets): do not double encode the data as json when saving an APIDataSet Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> * chore(lint): make pyling happy Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> --------- Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> Co-authored-by: Nok Lam Chan <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * build(datasets): release 1.5.2 (kedro-org#305) * release 1.5.2 minor release to fix the kedro-datasets optional dependencies issue * Update RELEASE.md * Trim whitespace Signed-off-by: Nok <nok.lam.chan@quantumblack.com> --------- Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: lrcouto <laurarccouto@gmail.com> * Add plugin contribution details to CONTRIBUTING.md Signed-off-by: lrcouto <laurarccouto@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Update CONTRIBUTING.md Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> * Apply minor changes on CONTRIBUTING.md Signed-off-by: lrcouto <laurarccouto@gmail.com> * Push code of conduct text block to the top on CONTRIBUTING.md Signed-off-by: L. R. Couto <laurarccouto@gmail.com> * Fix trailing whitespace lint error Signed-off-by: L. R. Couto <laurarccouto@gmail.com> --------- Signed-off-by: lrcouto <laurarccouto@gmail.com> Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com> Signed-off-by: Nok <nok.lam.chan@quantumblack.com> Signed-off-by: L. R. Couto <laurarccouto@gmail.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com> Signed-off-by: Florian Gaudin-Delrieu <fgaudindelrieu@idmog.com> Signed-off-by: Florian Gaudin-Delrieu <florian.gaudindelrieu@gmail.com> Co-authored-by: Dmitry Sorokin <40151847+DimedS@users.noreply.github.com> Co-authored-by: Nok <nok.lam.chan@quantumblack.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Merel Theisen <49397448+merelcht@users.noreply.github.com> Co-authored-by: Florian Gaudin-Delrieu <9217921+FlorianGD@users.noreply.github.com> Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Description
Temporary solution for: #261
Development notes
This approach adds a build that runs:
python -m sphinx -WETan -j auto -D language=en -b linkcheck -d _build/doctrees docs/source _build/linkcheck
This is the check in the read the docs builds that flags syntax issues etc in the docs. It's also the check that has failed and blocked Kedro releases previously, because there were syntax errors in the datasets doc strings that are not caught by the regular linters.
Questions for reviewers
conf.py
that weren't necessary. I wasn't sure about any files insource/_templates
. Are those needed @astrojuanlu / @stichbury ?conf.py
if we're happy with just running the check instead of producing full docs?Checklist
RELEASE.md
file