From 2fbe0d0ddbc5681fe918c5a710ac1f1d8819a3c8 Mon Sep 17 00:00:00 2001 From: huongg Date: Wed, 24 Apr 2024 12:25:49 +0100 Subject: [PATCH 01/16] setup vale.ini Signed-off-by: huongg --- .vale.ini | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .vale.ini diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000000..5f4e3c3a7c --- /dev/null +++ b/.vale.ini @@ -0,0 +1,7 @@ +StylesPath = .github/styles + +MinAlertLevel = suggestion + +[*.md] +BasedOnStyles = Vale, Kedro-viz +Vale.Spelling = NO \ No newline at end of file From 8dd63461321a87e81b156158c04a5d3d6547829e Mon Sep 17 00:00:00 2001 From: huongg Date: Wed, 24 Apr 2024 12:31:52 +0100 Subject: [PATCH 02/16] set linter check on docs or md file Signed-off-by: huongg --- .github/workflows/docs-language-linter.yml | 17 +++++++++++++ .github/workflows/docs-only-checks.yml | 28 ++++++++++++++++++++++ 2 files changed, 45 insertions(+) create mode 100644 .github/workflows/docs-language-linter.yml create mode 100644 .github/workflows/docs-only-checks.yml diff --git a/.github/workflows/docs-language-linter.yml b/.github/workflows/docs-language-linter.yml new file mode 100644 index 0000000000..20980c3f49 --- /dev/null +++ b/.github/workflows/docs-language-linter.yml @@ -0,0 +1,17 @@ +name: Language Linter for Kedro-viz Docs +on: + workflow_dispatch: + pull_request: + paths: + - "docs/**" + - '**.md' + +jobs: + vale: + name: runner / vale + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: errata-ai/vale-action@reviewdog + with: + reporter: github-pr-check \ No newline at end of file diff --git a/.github/workflows/docs-only-checks.yml b/.github/workflows/docs-only-checks.yml new file mode 100644 index 0000000000..6910816f12 --- /dev/null +++ b/.github/workflows/docs-only-checks.yml @@ -0,0 +1,28 @@ +name: Run linter on Kedro-viz Docs + +on: + push: + branches: + - main + - develop + paths: + - "docs/**" + - '**.md' + pull_request: + branches: + - main + - develop + paths: + - "docs/**" + - '**.md' + +jobs: + lint: + strategy: + matrix: + os: [ ubuntu-latest ] + python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ] + uses: ./.github/workflows/lint.yml + with: + os: ${{ matrix.os }} + python-version: ${{ matrix.python-version }} \ No newline at end of file From c8349917a3a84f700028b80ac0030503e004dd4f Mon Sep 17 00:00:00 2001 From: huongg Date: Wed, 24 Apr 2024 13:47:34 +0100 Subject: [PATCH 03/16] add styling for kedro-viz docs Signed-off-by: huongg --- .github/styles/Kedro-viz/Spellings.yml | 6 + .github/styles/Kedro-viz/abbreviations.yml | 11 + .github/styles/Kedro-viz/gender.yml | 13 ++ .github/styles/Kedro-viz/headings.yml | 56 +++++ .github/styles/Kedro-viz/ignore-names.txt | 111 ++++++++++ .github/styles/Kedro-viz/ignore.txt | 33 +++ .github/styles/Kedro-viz/inclusive.yml | 12 ++ .github/styles/Kedro-viz/links.yml | 12 ++ .github/styles/Kedro-viz/oxfordcomma.yml | 6 + .github/styles/Kedro-viz/pronouns.yml | 11 + .github/styles/Kedro-viz/sentencelength.yml | 11 + .github/styles/Kedro-viz/toowordy.yml | 218 ++++++++++++++++++++ .github/styles/Kedro-viz/ukspelling.yml | 28 +++ .github/styles/Kedro-viz/weaselwords.yml | 207 +++++++++++++++++++ .github/styles/Kedro-viz/words.yml | 53 +++++ 15 files changed, 788 insertions(+) create mode 100644 .github/styles/Kedro-viz/Spellings.yml create mode 100644 .github/styles/Kedro-viz/abbreviations.yml create mode 100644 .github/styles/Kedro-viz/gender.yml create mode 100644 .github/styles/Kedro-viz/headings.yml create mode 100644 .github/styles/Kedro-viz/ignore-names.txt create mode 100644 .github/styles/Kedro-viz/ignore.txt create mode 100644 .github/styles/Kedro-viz/inclusive.yml create mode 100644 .github/styles/Kedro-viz/links.yml create mode 100644 .github/styles/Kedro-viz/oxfordcomma.yml create mode 100644 .github/styles/Kedro-viz/pronouns.yml create mode 100644 .github/styles/Kedro-viz/sentencelength.yml create mode 100644 .github/styles/Kedro-viz/toowordy.yml create mode 100644 .github/styles/Kedro-viz/ukspelling.yml create mode 100644 .github/styles/Kedro-viz/weaselwords.yml create mode 100644 .github/styles/Kedro-viz/words.yml diff --git a/.github/styles/Kedro-viz/Spellings.yml b/.github/styles/Kedro-viz/Spellings.yml new file mode 100644 index 0000000000..c62ba64bc8 --- /dev/null +++ b/.github/styles/Kedro-viz/Spellings.yml @@ -0,0 +1,6 @@ +extends: spelling +message: "Did you really mean '%s'?" +level: warning +ignore: + - Kedro/ignore.txt + - Kedro/ignore-names.txt \ No newline at end of file diff --git a/.github/styles/Kedro-viz/abbreviations.yml b/.github/styles/Kedro-viz/abbreviations.yml new file mode 100644 index 0000000000..986b14c67b --- /dev/null +++ b/.github/styles/Kedro-viz/abbreviations.yml @@ -0,0 +1,11 @@ +extends: substitution +message: "Use '%s' instead of abbreviations like '%s'." +ignorecase: true +level: warning +nonword: true +action: + name: replace +swap: + '\b(?:eg|e\.g\.|eg\.)[\s,]': for example + '\b(?:ie|i\.e\.|ie\.)[\s,]': that is + '\b(?:etc)[\s\n,.]': and more \ No newline at end of file diff --git a/.github/styles/Kedro-viz/gender.yml b/.github/styles/Kedro-viz/gender.yml new file mode 100644 index 0000000000..2e00326f0f --- /dev/null +++ b/.github/styles/Kedro-viz/gender.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Use a gender-neutral pronoun instead of '%s'." +level: error +ignorecase: true +tokens: + - he/she + - s/he + - \(s\)he + - \bhe\b + - \bhim\b + - \bhis\b + - \bshe\b + - \bher\b \ No newline at end of file diff --git a/.github/styles/Kedro-viz/headings.yml b/.github/styles/Kedro-viz/headings.yml new file mode 100644 index 0000000000..e250d1df25 --- /dev/null +++ b/.github/styles/Kedro-viz/headings.yml @@ -0,0 +1,56 @@ +extends: capitalization +message: "'%s' should use sentence-style capitalization." +level: warning +scope: heading +match: $sentence +exceptions: + - Kedro + - Kedro-Viz + - Airflow + - Amazon + - Amazon Web Services + - AWS Step Functions + - AWS Systems Manager + - Azure + - Azure App Service + - Azure App Service Plan + - Azure Blob Storage + - Azure Event Hub + - CI/CD + - DataCatalog + - Data Catalog + - Docker + - Docker Compose + - Docker Swarm + - Dockerfile + - GitHub + - GitHub Actions + - Google + - Google Analytics + - Google Cloud + - Google Cloud Functions + - GraphQL + - Hook + - Hooks + - IDs + - Jenkins + - JFrog + - JFrog Artifactory + - Jira + - Kafka + - Kubernetes + - Kubernetes Engine + - Kubernetes Pod + - Kubernetes Service + - Lambda + - Linux + - MySQL + - Python + - QuantumBlack + - QuantumBlack Labs + - Red Hat + - Redis + - Slack + - Ubuntu + - Unix + - URLs \ No newline at end of file diff --git a/.github/styles/Kedro-viz/ignore-names.txt b/.github/styles/Kedro-viz/ignore-names.txt new file mode 100644 index 0000000000..ac2c286e40 --- /dev/null +++ b/.github/styles/Kedro-viz/ignore-names.txt @@ -0,0 +1,111 @@ +Ahdra +Aris +Alves +Alam +Andrew +Andrii +Anton +Antony +Ankita +Batori +Braccialli +Brummitt +Cano +Carvalho +Cvetanka +Czakon +Chan +Comym +Couto +Daiha +Dada +Danov +Datta +DeBold +Deepyaman +Deriabin +Diaz +Dmitrii +Dmitry +Emamjome +Erins +Gabriel +Gundaniya +Guilherme +Hamza +Hoang +Holzer +Huong +Helmhold +Ignacio +Ivaniuk +Ivan +Jakub +Jannic +Jankowski +Jitendra +Jiri +Jo +Joel +Juan +Kadiri +Kaiser +Kaltsas +Kanchwala +Katiyar +Khan +Kirilenko +Kiyohito +Klein +Kunii +Kumar +Lais +Laura +Liam +Lim +Lorena +Machado +Mackay +Malte +Malloy +Marcin +Meisam +Merali +Merel +Milne +Nasef +Nechevska +Nero +Nguyen +Nikolaos +Nikolic +Nok +Okwa +Oza +Paricio +Patel +Peteris +Pilla +Rashida +Ravi +Richard +Schwarzmann +Sorokin +Stichbury +Susanna +Sajid +Stephanie +Takieddine +Theisen +Tynan +Tsaousis +Valtazanos +Vladimir +Waylon +Westenra +Wong +Wrigley +Yolan +Yetunde +Zablocki +Zain \ No newline at end of file diff --git a/.github/styles/Kedro-viz/ignore.txt b/.github/styles/Kedro-viz/ignore.txt new file mode 100644 index 0000000000..21d52adda3 --- /dev/null +++ b/.github/styles/Kedro-viz/ignore.txt @@ -0,0 +1,33 @@ +Kedro +kedro +Kedro's +kedro's +Kubeflow +Databricks +Conda +conda +Cookiecutter +config +fsspec +Kaggle +namespace +namespaces +namespaced +regressors +repo +Repo +dbx +MLflow +csv +yaml +matplotlib +Matplotlib +IPython +APIs +networkx +Plotly +Pylint +SQLAlchemy +Astro +Xebia +pytest \ No newline at end of file diff --git a/.github/styles/Kedro-viz/inclusive.yml b/.github/styles/Kedro-viz/inclusive.yml new file mode 100644 index 0000000000..aa79a3f2c1 --- /dev/null +++ b/.github/styles/Kedro-viz/inclusive.yml @@ -0,0 +1,12 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +ignorecase: true +level: error +action: + name: replace +swap: + # bad: good + 'black ?list': 'disallow list|exclude list' + 'master': primary + 'slave': secondary + 'white ?list': 'allow list|include list' \ No newline at end of file diff --git a/.github/styles/Kedro-viz/links.yml b/.github/styles/Kedro-viz/links.yml new file mode 100644 index 0000000000..aa79a3f2c1 --- /dev/null +++ b/.github/styles/Kedro-viz/links.yml @@ -0,0 +1,12 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +ignorecase: true +level: error +action: + name: replace +swap: + # bad: good + 'black ?list': 'disallow list|exclude list' + 'master': primary + 'slave': secondary + 'white ?list': 'allow list|include list' \ No newline at end of file diff --git a/.github/styles/Kedro-viz/oxfordcomma.yml b/.github/styles/Kedro-viz/oxfordcomma.yml new file mode 100644 index 0000000000..5b9c7dbff8 --- /dev/null +++ b/.github/styles/Kedro-viz/oxfordcomma.yml @@ -0,0 +1,6 @@ +extends: existence +message: "Use the Oxford comma in '%s'." +scope: sentence +level: suggestion +tokens: + - '(?:[^,]+,){1,}\s\w+\s(?:and|or)' \ No newline at end of file diff --git a/.github/styles/Kedro-viz/pronouns.yml b/.github/styles/Kedro-viz/pronouns.yml new file mode 100644 index 0000000000..d6ad378172 --- /dev/null +++ b/.github/styles/Kedro-viz/pronouns.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Avoid first-person singular pronouns such as '%s'." +level: warning +nonword: true +tokens: + - (?<=^|\s)I(?=\s) + - (?<=^|\s)I,(?=\s) + - \bI'm\b + - (?<=\s)[Mm]e\b + - (?<=\s)[Mm]y\b + - (?<=\s)[Mm]ine\b \ No newline at end of file diff --git a/.github/styles/Kedro-viz/sentencelength.yml b/.github/styles/Kedro-viz/sentencelength.yml new file mode 100644 index 0000000000..4a8042ea13 --- /dev/null +++ b/.github/styles/Kedro-viz/sentencelength.yml @@ -0,0 +1,11 @@ +extends: occurrence +message: "Try to keep your sentence length to 30 words or fewer." +level: suggestion +# Here, we're counting the number of words +# in a sentence. +# +# If there are more than 30, we'll flag it. +scope: sentence +ignorecase: false +max: 30 +token: (\w+) \ No newline at end of file diff --git a/.github/styles/Kedro-viz/toowordy.yml b/.github/styles/Kedro-viz/toowordy.yml new file mode 100644 index 0000000000..320bfaf3fe --- /dev/null +++ b/.github/styles/Kedro-viz/toowordy.yml @@ -0,0 +1,218 @@ +# Write Good's "Too wordy" rule https://github.com/testthedocs/vale-styles/blob/master/write-good/TooWordy.yml +extends: existence +message: "'%s' is too wordy" +ignorecase: true +level: warning +tokens: + - a number of + - abundance + - accede to + - accelerate + - accentuate + - accompany + - accomplish + - accorded + - accrue + - acquiesce + - acquire + - adjacent to + - adjustment + - admissible + - advantageous + - adversely impact + - advise + - aforementioned + - aggregate + - aircraft + - all of + - all things considered + - alleviate + - allocate + - along the lines of + - already existing + - alternatively + - amazing + - ameliorate + - anticipate + - apparent + - appreciable + - as a matter of fact + - as a means of + - as far as I'm concerned + - as of yet + - as to + - as yet + - ascertain + - assistance + - at the present time + - at this time + - attain + - attributable to + - because of the fact that + - belated + - benefit from + - bestow + - by means of + - by virtue of the fact that + - by virtue of + - cease + - close proximity + - commence + - comply with + - concerning + - consequently + - consolidate + - constitutes + - demonstrate + - depart + - designate + - discontinue + - due to the fact that + - each and every + - economical + - eliminate + - elucidate + - employ + - endeavor + - enumerate + - equitable + - equivalent + - evaluate + - evidenced + - exclusively + - expedite + - expend + - expiration + - facilitate + - factual evidence + - feasible + - finalise + - first and foremost + - for all intents and purposes + - for the most part + - for the purpose of + - forfeit + - formulate + - have a tendency to + - honest truth + - however + - if and when + - impacted + - implement + - in a manner of speaking + - in a timely manner + - in a very real sense + - in accordance with + - in addition + - in all likelihood + - in an effort to + - in between + - in excess of + - in lieu of + - in light of the fact that + - in many cases + - in my opinion + - in order to + - in regard to + - in some instances + - in terms of + - in the case of + - in the event that + - in the final analysis + - in the nature of + - in the near future + - in the process of + - inception + - incumbent upon + - indicate + - indication + - initiate + - irregardless + - is applicable to + - is authorised to + - is responsible for + - it is essential + - it seems that + - it was + - magnitude + - maximum + - methodology + - minimise + - modify + - monitor + - multiple + - necessitate + - nevertheless + - not certain + - not many + - not often + - not unless + - not unlike + - notwithstanding + - null and void + - numerous + - objective + - obligate + - obtain + - on the contrary + - on the other hand + - one particular + - optimum + - overall + - owing to the fact that + - participate + - particulars + - pass away + - pertaining to + - point in time + - portion + - possess + - preclude + - previously + - prior to + - prioritise + - procure + - proficiency + - provided that + - purchase + - put simply + - readily apparent + - refer back + - regarding + - relocate + - remainder + - remuneration + - requirement + - reside + - residence + - retain + - satisfy + - shall + - should you wish + - similar to + - solicit + - span across + - strategise + - subsequent + - substantial + - successfully complete + - sufficient + - terminate + - the month of + - the point I am trying to make + - therefore + - time period + - took advantage of + - transmit + - transpire + - type of + - until such time as + - utilisation + - utilise + - validate + - various different + - what I mean to say is + - whether or not + - with respect to + - with the exception of + - witnessed \ No newline at end of file diff --git a/.github/styles/Kedro-viz/ukspelling.yml b/.github/styles/Kedro-viz/ukspelling.yml new file mode 100644 index 0000000000..10c8439ca8 --- /dev/null +++ b/.github/styles/Kedro-viz/ukspelling.yml @@ -0,0 +1,28 @@ +extends: existence +message: "In general, use UK English spelling instead of '%s'." +link: 'https://github.com/kedro-org/kedro/wiki/Kedro-documentation-style-guide' +ignorecase: true +level: warning +tokens: + - '(?:\w+)zation' + - '(?:\w+)izing' + - '(?:\w+)izer' + - '(?:\w+)ized' + - '(?:\w+)ize' + - '(?:\w+)log' + - '(?:\w+)lor' + - '(?:\w+)lyze' +exceptions: + - backlog + - blog + - capsize + - catalog + - Catalog + - DataCatalog + - dialog + - log + - maize + - prize + - seize + - size + - tailor \ No newline at end of file diff --git a/.github/styles/Kedro-viz/weaselwords.yml b/.github/styles/Kedro-viz/weaselwords.yml new file mode 100644 index 0000000000..bb8001fbc1 --- /dev/null +++ b/.github/styles/Kedro-viz/weaselwords.yml @@ -0,0 +1,207 @@ +# Write Good's Weasel Words rule https://github.com/testthedocs/vale-styles/blob/master/write-good/Weasel.yml +extends: existence +message: "'%s' is a weasel word!" +ignorecase: true +level: warning +tokens: + - absolutely + - accidentally + - additionally + - allegedly + - alternatively + - angrily + - anxiously + - approximately + - awkwardly + - badly + - barely + - beautifully + - blindly + - boldly + - bravely + - brightly + - briskly + - bristly + - bubbly + - busily + - calmly + - carefully + - carelessly + - cautiously + - cheerfully + - clearly + - closely + - coldly + - completely + - consequently + - correctly + - courageously + - crinkly + - cruelly + - crumbly + - cuddly + - currently + - daily + - daringly + - deadly + - definitely + - deliberately + - doubtfully + - dumbly + - eagerly + - easily + - elegantly + - enormously + - enthusiastically + - equally + - especially + - eventually + - exactly + - exceedingly + - exclusively + - extremely + - fairly + - faithfully + - fatally + - fiercely + - finally + - fondly + - few + - foolishly + - fortunately + - frankly + - frantically + - generously + - gently + - giggly + - gladly + - gracefully + - greedily + - happily + - hardly + - hastily + - healthily + - heartily + - helpfully + - honestly + - hourly + - hungrily + - hurriedly + - immediately + - impatiently + - inadequately + - ingeniously + - innocently + - inquisitively + - interestingly + - irritably + - jiggly + - joyously + - justly + - kindly + - largely + - lately + - lazily + - likely + - literally + - lonely + - loosely + - loudly + - loudly + - luckily + - madly + - many + - mentally + - mildly + - monthly + - mortally + - mostly + - mysteriously + - neatly + - nervously + - nightly + - noisily + - normally + - obediently + - occasionally + - only + - openly + - painfully + - particularly + - patiently + - perfectly + - politely + - poorly + - powerfully + - presumably + - previously + - promptly + - punctually + - quarterly + - quickly + - quietly + - rapidly + - rarely + - really + - recently + - recklessly + - regularly + - remarkably + - relatively + - reluctantly + - repeatedly + - rightfully + - roughly + - rudely + - sadly + - safely + - selfishly + - sensibly + - seriously + - sharply + - shortly + - shyly + - significantly + - silently + - simply + - sleepily + - slowly + - smartly + - smelly + - smoothly + - softly + - solemnly + - sparkly + - speedily + - stealthily + - sternly + - stupidly + - substantially + - successfully + - suddenly + - surprisingly + - suspiciously + - swiftly + - tenderly + - tensely + - thoughtfully + - tightly + - timely + - truthfully + - unexpectedly + - unfortunately + - usually + - very + - victoriously + - violently + - vivaciously + - warmly + - waverly + - weakly + - wearily + - weekly + - wildly + - wisely + - worldly + - wrinkly + - yearly \ No newline at end of file diff --git a/.github/styles/Kedro-viz/words.yml b/.github/styles/Kedro-viz/words.yml new file mode 100644 index 0000000000..0a9a1d3433 --- /dev/null +++ b/.github/styles/Kedro-viz/words.yml @@ -0,0 +1,53 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +ignorecase: false +level: warning +action: + name: replace +swap: + # bad: good + 'acknowledgement': 'acknowledgment' + 'auto-complete': 'autocomplete' + 'a number of': 'few|several|many' + 'and/or': 'and|or|either or' + 'back end': 'backend' + 'bear in mind': 'keep in mind' + 'culprit': 'cause' + 'data set': 'dataset' + 'drill down|drilling down|drill into|drilling into': 'examine|investigate|analyze' + 'figure out': 'determine' + 'fine tune|fine-tune': 'customize|optimize|refine' + 'for the most part': 'generally|usually' + 'front end': 'frontend' + 'highly|very': '' + 'hit': 'click|select' + 'in order to': 'to' + 'keep in mind': 'consider' + 'left up to': 'determined by' + 'leverage': 'use' + 'multi-alert': 'multi alert' + 'Note that': '**Note**:' + 'obviously|obvious': '' + 'on the fly': 'real-time|real time' + 'once': 'after' + 'play a hand': 'influence' + 'please|just': '' + 'easily|easy': '' + 'quickly|quick': '' + 'screen board': 'screenboard' + 'simply|simple': '' + 'stand for': 'represents|means' + 'reenable': 're-enable' + 'run time': 'runtime' + 'refer to|visit': 'see|read|follow' + 'time board': 'timeboard' + 'time series': 'timeseries' + 'toplist': 'top list' + 'tradeoff': 'trade-off' + 'turnkey': 'ready to use' + 'under the hood': '' + 'utilize': 'use' + 'via': 'with|through' + 'visit': 'see|read' + 'webserver': 'web server' + 'web site': 'website' \ No newline at end of file From bebb82ad355337a6157dc1f8572f7614979b7f5b Mon Sep 17 00:00:00 2001 From: huongg Date: Wed, 24 Apr 2024 13:50:43 +0100 Subject: [PATCH 04/16] testing Signed-off-by: huongg --- docs/source/kedro-viz_visualisation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/kedro-viz_visualisation.md b/docs/source/kedro-viz_visualisation.md index fa356ff2c9..f6c1da17a4 100644 --- a/docs/source/kedro-viz_visualisation.md +++ b/docs/source/kedro-viz_visualisation.md @@ -190,6 +190,8 @@ The `%run_viz` line magic allows you to display an interactive visualisation of To use the `%run_viz` line magic without any arguments, simply run: +testing ljsfljskfjisdfhk + ```ipython %run_viz ``` From 34164fc399298cc21194f1b1223f66ddd5b988a1 Mon Sep 17 00:00:00 2001 From: huongg Date: Wed, 24 Apr 2024 15:20:13 +0100 Subject: [PATCH 05/16] remove python v 3.8 as we don't support it anymore Signed-off-by: huongg --- .github/workflows/docs-only-checks.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-only-checks.yml b/.github/workflows/docs-only-checks.yml index 6910816f12..65c9f9bef9 100644 --- a/.github/workflows/docs-only-checks.yml +++ b/.github/workflows/docs-only-checks.yml @@ -21,7 +21,7 @@ jobs: strategy: matrix: os: [ ubuntu-latest ] - python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ] + python-version: ["3.9", "3.10", "3.11", "3.12" ] uses: ./.github/workflows/lint.yml with: os: ${{ matrix.os }} From 90650def36065fae0ae2f44fd93446aae85da1a2 Mon Sep 17 00:00:00 2001 From: huongg Date: Thu, 25 Apr 2024 15:03:42 +0100 Subject: [PATCH 06/16] remove python 3.12 Signed-off-by: huongg --- .github/workflows/docs-only-checks.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-only-checks.yml b/.github/workflows/docs-only-checks.yml index 65c9f9bef9..a86fe25036 100644 --- a/.github/workflows/docs-only-checks.yml +++ b/.github/workflows/docs-only-checks.yml @@ -21,7 +21,7 @@ jobs: strategy: matrix: os: [ ubuntu-latest ] - python-version: ["3.9", "3.10", "3.11", "3.12" ] + python-version: ["3.9", "3.10", "3.11"] uses: ./.github/workflows/lint.yml with: os: ${{ matrix.os }} From 4ddbba2758688e62e8c7f680071b37d17385a6cb Mon Sep 17 00:00:00 2001 From: Ankita Katiyar Date: Fri, 26 Apr 2024 11:15:56 +0100 Subject: [PATCH 07/16] Try docs build with build-docs.sh Signed-off-by: Ankita Katiyar --- .readthedocs.yml | 7 +++++++ docs/Makefile | 20 -------------------- docs/build-docs.sh | 14 ++++++++++++++ docs/make.bat | 35 ----------------------------------- 4 files changed, 21 insertions(+), 55 deletions(-) delete mode 100644 docs/Makefile create mode 100644 docs/build-docs.sh delete mode 100644 docs/make.bat diff --git a/.readthedocs.yml b/.readthedocs.yml index 57e08a91fc..062780a4ac 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -9,6 +9,13 @@ build: tools: python: "3.9" nodejs: "19" + jobs: + post_checkout: + - git fetch --unshallow || true + pre_build: + - pip freeze + - python -m sphinx -WETan -j auto -D language=en -b linkcheck -d _build/doctrees docs/source _build/linkcheck + sphinx: builder: html diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index d0c3cbf102..0000000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/build-docs.sh b/docs/build-docs.sh new file mode 100644 index 0000000000..89cecc80cb --- /dev/null +++ b/docs/build-docs.sh @@ -0,0 +1,14 @@ +#!/usr/bin/env bash + +set -e + +# Exit script if you try to use an uninitialized variable. +set -o nounset + +action=$1 + +if [ "$action" == "linkcheck" ]; then + sphinx-build -WETan -j auto -D language=en -b linkcheck -d docs/build/doctrees docs/source docs/build/linkcheck +elif [ "$action" == "docs" ]; then + sphinx-build -WETa --keep-going -j auto -D language=en -b html -d docs/build/doctrees docs/source docs/build/html +fi diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 747ffb7b30..0000000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.https://www.sphinx-doc.org/ - exit /b 1 -) - -if "%1" == "" goto help - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd From 397556625b87dfeac11470de3edcf114ca8c059a Mon Sep 17 00:00:00 2001 From: huongg Date: Mon, 29 Apr 2024 14:56:19 +0100 Subject: [PATCH 08/16] testing the doc build Signed-off-by: huongg --- docs/source/kedro-viz_visualisation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/kedro-viz_visualisation.md b/docs/source/kedro-viz_visualisation.md index f6c1da17a4..963a1ef89a 100644 --- a/docs/source/kedro-viz_visualisation.md +++ b/docs/source/kedro-viz_visualisation.md @@ -3,6 +3,8 @@ This section assumes you are familiar with the basic Kedro concepts described in the {doc}`spaceflights tutorial`. If you have not yet worked through the tutorial, you can still follow this example. +This line is to test our the doc build. + If you haven't installed Kedro {doc}`follow the documentation to get set up`. ```{important} From accb757b9b32a7b10a7f6d49445a3c713bb9201a Mon Sep 17 00:00:00 2001 From: huongg Date: Mon, 29 Apr 2024 21:21:23 +0100 Subject: [PATCH 09/16] update release note Signed-off-by: huongg --- RELEASE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/RELEASE.md b/RELEASE.md index e9dc534e79..23975b4f26 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -13,6 +13,7 @@ Please follow the established format: - Upgrade the gitpod workspace-full to a newer version which includes both Node 18 and Python 3.11.5. (#1862) - Refactor backend integration with Kedro by replacing bootstrap_project with configure_project. (#1796) +- Enhance kedro-viz doc integration. (#1874) # Release 9.0.0 From 2a34e089e3198f25a1fb1d7fe565f98268493e38 Mon Sep 17 00:00:00 2001 From: Huong Nguyen <32060364+Huongg@users.noreply.github.com> Date: Wed, 1 May 2024 15:03:23 +0100 Subject: [PATCH 10/16] Update .github/styles/Kedro-viz/Spellings.yml Co-authored-by: Ankita Katiyar <110245118+ankatiyar@users.noreply.github.com> Signed-off-by: Huong Nguyen <32060364+Huongg@users.noreply.github.com> --- .github/styles/Kedro-viz/Spellings.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/styles/Kedro-viz/Spellings.yml b/.github/styles/Kedro-viz/Spellings.yml index c62ba64bc8..71234b5ad4 100644 --- a/.github/styles/Kedro-viz/Spellings.yml +++ b/.github/styles/Kedro-viz/Spellings.yml @@ -2,5 +2,5 @@ extends: spelling message: "Did you really mean '%s'?" level: warning ignore: - - Kedro/ignore.txt + - Kedro-viz/ignore.txt - Kedro/ignore-names.txt \ No newline at end of file From 82dfb82dd6f1ccaa1922b5b508bbcb77f90ec573 Mon Sep 17 00:00:00 2001 From: Huong Nguyen <32060364+Huongg@users.noreply.github.com> Date: Wed, 1 May 2024 15:03:33 +0100 Subject: [PATCH 11/16] Update .github/styles/Kedro-viz/Spellings.yml Co-authored-by: Ankita Katiyar <110245118+ankatiyar@users.noreply.github.com> Signed-off-by: Huong Nguyen <32060364+Huongg@users.noreply.github.com> --- .github/styles/Kedro-viz/Spellings.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/styles/Kedro-viz/Spellings.yml b/.github/styles/Kedro-viz/Spellings.yml index 71234b5ad4..6a1c9c9b64 100644 --- a/.github/styles/Kedro-viz/Spellings.yml +++ b/.github/styles/Kedro-viz/Spellings.yml @@ -2,5 +2,4 @@ extends: spelling message: "Did you really mean '%s'?" level: warning ignore: - - Kedro-viz/ignore.txt - - Kedro/ignore-names.txt \ No newline at end of file + - Kedro-viz/ignore.txt \ No newline at end of file From 0cc5b077e8cd5789844e749b056bfbe6259b0acb Mon Sep 17 00:00:00 2001 From: Huong Nguyen <32060364+Huongg@users.noreply.github.com> Date: Wed, 1 May 2024 15:03:46 +0100 Subject: [PATCH 12/16] Update .github/workflows/docs-only-checks.yml Co-authored-by: Ankita Katiyar <110245118+ankatiyar@users.noreply.github.com> Signed-off-by: Huong Nguyen <32060364+Huongg@users.noreply.github.com> --- .github/workflows/docs-only-checks.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/docs-only-checks.yml b/.github/workflows/docs-only-checks.yml index a86fe25036..71759bf6cf 100644 --- a/.github/workflows/docs-only-checks.yml +++ b/.github/workflows/docs-only-checks.yml @@ -4,7 +4,6 @@ on: push: branches: - main - - develop paths: - "docs/**" - '**.md' From 7989a881cad86b3e32391464f0594c2825490ac3 Mon Sep 17 00:00:00 2001 From: Huong Nguyen <32060364+Huongg@users.noreply.github.com> Date: Wed, 1 May 2024 15:03:51 +0100 Subject: [PATCH 13/16] Update .github/workflows/docs-only-checks.yml Co-authored-by: Ankita Katiyar <110245118+ankatiyar@users.noreply.github.com> Signed-off-by: Huong Nguyen <32060364+Huongg@users.noreply.github.com> --- .github/workflows/docs-only-checks.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/docs-only-checks.yml b/.github/workflows/docs-only-checks.yml index 71759bf6cf..bd09e387e8 100644 --- a/.github/workflows/docs-only-checks.yml +++ b/.github/workflows/docs-only-checks.yml @@ -10,7 +10,6 @@ on: pull_request: branches: - main - - develop paths: - "docs/**" - '**.md' From 9e03b47edd046a1b7117d1813525b2bdc989f182 Mon Sep 17 00:00:00 2001 From: Huong Nguyen <32060364+Huongg@users.noreply.github.com> Date: Thu, 2 May 2024 10:45:08 +0100 Subject: [PATCH 14/16] Update .readthedocs.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Juan Luis Cano Rodríguez Signed-off-by: Huong Nguyen <32060364+Huongg@users.noreply.github.com> --- .readthedocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 062780a4ac..4faaef3ab6 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -8,7 +8,6 @@ build: os: ubuntu-22.04 tools: python: "3.9" - nodejs: "19" jobs: post_checkout: - git fetch --unshallow || true From 392e572fb54da6f64e00c11c141410305ae124aa Mon Sep 17 00:00:00 2001 From: huongg Date: Thu, 2 May 2024 11:34:16 +0100 Subject: [PATCH 15/16] remove test line Signed-off-by: huongg --- docs/source/kedro-viz_visualisation.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/source/kedro-viz_visualisation.md b/docs/source/kedro-viz_visualisation.md index 963a1ef89a..fa356ff2c9 100644 --- a/docs/source/kedro-viz_visualisation.md +++ b/docs/source/kedro-viz_visualisation.md @@ -3,8 +3,6 @@ This section assumes you are familiar with the basic Kedro concepts described in the {doc}`spaceflights tutorial`. If you have not yet worked through the tutorial, you can still follow this example. -This line is to test our the doc build. - If you haven't installed Kedro {doc}`follow the documentation to get set up`. ```{important} @@ -192,8 +190,6 @@ The `%run_viz` line magic allows you to display an interactive visualisation of To use the `%run_viz` line magic without any arguments, simply run: -testing ljsfljskfjisdfhk - ```ipython %run_viz ``` From 27ae78a02cf8ee6e50994bcdc3c3231008034bb7 Mon Sep 17 00:00:00 2001 From: huongg Date: Thu, 2 May 2024 11:46:18 +0100 Subject: [PATCH 16/16] remove ignore-name file as its only used in kedro framework Signed-off-by: huongg --- .github/styles/Kedro-viz/ignore-names.txt | 111 ---------------------- 1 file changed, 111 deletions(-) delete mode 100644 .github/styles/Kedro-viz/ignore-names.txt diff --git a/.github/styles/Kedro-viz/ignore-names.txt b/.github/styles/Kedro-viz/ignore-names.txt deleted file mode 100644 index ac2c286e40..0000000000 --- a/.github/styles/Kedro-viz/ignore-names.txt +++ /dev/null @@ -1,111 +0,0 @@ -Ahdra -Aris -Alves -Alam -Andrew -Andrii -Anton -Antony -Ankita -Batori -Braccialli -Brummitt -Cano -Carvalho -Cvetanka -Czakon -Chan -Comym -Couto -Daiha -Dada -Danov -Datta -DeBold -Deepyaman -Deriabin -Diaz -Dmitrii -Dmitry -Emamjome -Erins -Gabriel -Gundaniya -Guilherme -Hamza -Hoang -Holzer -Huong -Helmhold -Ignacio -Ivaniuk -Ivan -Jakub -Jannic -Jankowski -Jitendra -Jiri -Jo -Joel -Juan -Kadiri -Kaiser -Kaltsas -Kanchwala -Katiyar -Khan -Kirilenko -Kiyohito -Klein -Kunii -Kumar -Lais -Laura -Liam -Lim -Lorena -Machado -Mackay -Malte -Malloy -Marcin -Meisam -Merali -Merel -Milne -Nasef -Nechevska -Nero -Nguyen -Nikolaos -Nikolic -Nok -Okwa -Oza -Paricio -Patel -Peteris -Pilla -Rashida -Ravi -Richard -Schwarzmann -Sorokin -Stichbury -Susanna -Sajid -Stephanie -Takieddine -Theisen -Tynan -Tsaousis -Valtazanos -Vladimir -Waylon -Westenra -Wong -Wrigley -Yolan -Yetunde -Zablocki -Zain \ No newline at end of file