[x] Update GitHub actions to run the Vale "language linter" on changes to the Viz docs. This task includes:
Setup vale.ini
Reuse styles component set up by @stichbury for Kedro framework. This to be discussed with the wider team on how we can reuse this between framework and viz, as in even we might not change the styling very frequently, how about the names text ignore? Eg: if someone joins the team we will always have to remember to update them in 2 different places etc
[x] Revise the way the project initiates and runs a Sphinx build to more closely follow the Framework approach with a build-docs.sh that is initiated from a makefile. At present we run make html created by Sphinx. This task includes:
Include Sphinx build in readthedocs.yml
Follow build-docs.sh from Kedro framework
Description
Fixes #1637
Development notes
To enhance Kedro-viz current build to be more closely with Kedro Framework docs build, that includes:
[x] Update continuous integration to run a linter across the Viz docs. This task includes: Setup docs-language-linter Setup docs-only-checks
[x] Update GitHub actions to run the Vale "language linter" on changes to the Viz docs. This task includes: Setup vale.ini Reuse styles component set up by @stichbury for Kedro framework. This to be discussed with the wider team on how we can reuse this between framework and viz, as in even we might not change the styling very frequently, how about the names text ignore? Eg: if someone joins the team we will always have to remember to update them in 2 different places etc
[x] Revise the way the project initiates and runs a Sphinx build to more closely follow the Framework approach with a build-docs.sh that is initiated from a makefile. At present we run make html created by Sphinx. This task includes: Include Sphinx build in readthedocs.yml Follow build-docs.sh from Kedro framework
[ ] Add https://github.com/kedro-org/kedro-sphinx-theme for consistency for consistency with Framework To be done in a separate ticket. I've created the issue 1882 for us track
QA notes
Checklist
RELEASE.mdfile