From ac7ff02e664ce8d76be79359ed0a8bf6a0325e4f Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Thu, 20 Jun 2024 15:27:40 -0400 Subject: [PATCH 01/15] add getting help diagram to Xarray docs --- doc/getting-started-guide/help-diagram.rst | 80 ++++++++++++++++++++++ doc/getting-started-guide/index.rst | 1 + doc/index.rst | 3 +- 3 files changed, 83 insertions(+), 1 deletion(-) create mode 100644 doc/getting-started-guide/help-diagram.rst diff --git a/doc/getting-started-guide/help-diagram.rst b/doc/getting-started-guide/help-diagram.rst new file mode 100644 index 00000000000..fa1252c6cd8 --- /dev/null +++ b/doc/getting-started-guide/help-diagram.rst @@ -0,0 +1,80 @@ +Getting help-diagram +==================== + +Navigating the wealth of resources available for Xarray can be overwhelming. +We've created this flow chart to help guide you towards the best way to get help, depending on what you're working towards. +The links to each resource are provided below the diagram. +Regardless of how you interact with us, we're always thrilled to hear from you! + +```mermaid +--- +title: Navigating Xarray Resources +--- + + +flowchart TD + intro[Welcome to Xarray! How can we help?]:::quesNodefmt + usage([fa:fa-chalkboard-user Xarray Tutorials + fab:fa-readme Xarray Docs + fab:fa-google Google/fab:fa-stack-overflow Stack Exchange]):::ansNodefmt + API([fab:fa-readme Xarray Docs + fab:fa-readme extension's docs]):::ansNodefmt + help([fab:fa-github Xarray Discussions + fab:fa-discord Xarray Discord + fa:fa-users Xarray Office Hours + fa:fa-globe Pangeo Discourse]):::ansNodefmt + bug([Report and Propose here: + fab:fa-github Xarray Issues]):::ansNodefmt + contrib([fa:fa-book-open Xarray Contributor's Guide]):::ansNodefmt + pr(["fab:fa-github Pull Request (PR)"]):::ansNodefmt + dev([fab:fa-github '@' Ping a Maintainer + fa:fa-users Developer's Meeting]):::ansNodefmt + report[Thanks for letting us know!]:::quesNodefmt + merged[Woohoo! Your PR was merged!]:::quesNodefmt + + + intro -->|How do I use Xarray?| usage + usage -->|"with extensions (like Dask)"| API + + usage -->|I'd like some more help| help + intro -->|I found a bug or typo| bug + subgraph bugcontrib[Bugs and Contributions] + bug + contrib + bug -->|I just wanted to tell you| report + bug<-->|I'd like to fix the bug!| contrib + bug<-->|my plan was approved!| contrib + + end + + + intro -->|I wish Xarray could...| bug + + pr -->|my PR was approved| merged + + pr -->|my PR is quiet| dev + bug -->|my issue is quiet| dev + contrib -->pr + + classDef quesNodefmt fill:#9DEEF4,stroke:#206C89 + + classDef ansNodefmt fill:#FFAA05,stroke:#E37F17 + + classDef boxfmt fill:#FFF5ED,stroke:#E37F17 + class bugcontrib boxfmt + + linkStyle default font-size:20pt,color:#206C89 + +``` + +- `Xarray Tutorials `__ +- `Xarray Docs `__ +- `Google/Stack Exchange `__ +- `Xarray Discussions `__ +- `Xarray Discord `__ +- `Xarray Office Hours `__ +- `Pangeo Discourse `__ +- `Xarray Issues `__ +- `Xarray Contributors Guide `__ +- `Xarray Maintainers `__ +- `Developer's Meeting `__ diff --git a/doc/getting-started-guide/index.rst b/doc/getting-started-guide/index.rst index 20fd49fb2c4..b08b0be0fc7 100644 --- a/doc/getting-started-guide/index.rst +++ b/doc/getting-started-guide/index.rst @@ -13,3 +13,4 @@ It is designed as an entry point for new users, and it provided an introduction installing quick-overview faq + help-diagram diff --git a/doc/index.rst b/doc/index.rst index 138e9d91601..6ef6c62864a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -14,7 +14,8 @@ efficient, and fun! `Releases `__ | `Stack Overflow `__ | `Mailing List `__ | -`Blog `__ +`Blog `__ | +`Tutorials `__ .. grid:: 1 1 2 2 From 11b9edf75d2b83797e2b5cf83cb9d7abc8b4412b Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Thu, 20 Jun 2024 15:40:57 -0400 Subject: [PATCH 02/15] add config and switch to directive notation --- ci/requirements/doc.yml | 1 + doc/conf.py | 1 + doc/getting-started-guide/help-diagram.rst | 6 ++---- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/ci/requirements/doc.yml b/ci/requirements/doc.yml index 066d085ec53..39c2d4d6e88 100644 --- a/ci/requirements/doc.yml +++ b/ci/requirements/doc.yml @@ -42,5 +42,6 @@ dependencies: - sphinxext-rediraffe - zarr>=2.10 - pip: + - sphinxcontrib-mermaid # relative to this file. Needs to be editable to be accepted. - -e ../.. diff --git a/doc/conf.py b/doc/conf.py index 80b24445f71..8ac96c51a10 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -85,6 +85,7 @@ "sphinxext.rediraffe", "sphinx_design", "sphinx_inline_tabs", + "sphinxcontrib.mermaid", ] diff --git a/doc/getting-started-guide/help-diagram.rst b/doc/getting-started-guide/help-diagram.rst index fa1252c6cd8..d07efe96628 100644 --- a/doc/getting-started-guide/help-diagram.rst +++ b/doc/getting-started-guide/help-diagram.rst @@ -6,12 +6,11 @@ We've created this flow chart to help guide you towards the best way to get help The links to each resource are provided below the diagram. Regardless of how you interact with us, we're always thrilled to hear from you! -```mermaid +.. mermaid:: --- title: Navigating Xarray Resources --- - flowchart TD intro[Welcome to Xarray! How can we help?]:::quesNodefmt usage([fa:fa-chalkboard-user Xarray Tutorials @@ -65,7 +64,6 @@ flowchart TD linkStyle default font-size:20pt,color:#206C89 -``` - `Xarray Tutorials `__ - `Xarray Docs `__ @@ -77,4 +75,4 @@ flowchart TD - `Xarray Issues `__ - `Xarray Contributors Guide `__ - `Xarray Maintainers `__ -- `Developer's Meeting `__ +- `Developer's Meeting `__ \ No newline at end of file From db637420fd00ca01c812938c458ebe5e53550fce Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 20 Jun 2024 19:46:31 +0000 Subject: [PATCH 03/15] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- doc/getting-started-guide/help-diagram.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/getting-started-guide/help-diagram.rst b/doc/getting-started-guide/help-diagram.rst index d07efe96628..5fb8d95179a 100644 --- a/doc/getting-started-guide/help-diagram.rst +++ b/doc/getting-started-guide/help-diagram.rst @@ -34,7 +34,7 @@ flowchart TD intro -->|How do I use Xarray?| usage usage -->|"with extensions (like Dask)"| API - + usage -->|I'd like some more help| help intro -->|I found a bug or typo| bug subgraph bugcontrib[Bugs and Contributions] @@ -42,11 +42,11 @@ flowchart TD contrib bug -->|I just wanted to tell you| report bug<-->|I'd like to fix the bug!| contrib - bug<-->|my plan was approved!| contrib - + bug<-->|my plan was approved!| contrib + end - - + + intro -->|I wish Xarray could...| bug pr -->|my PR was approved| merged @@ -75,4 +75,4 @@ flowchart TD - `Xarray Issues `__ - `Xarray Contributors Guide `__ - `Xarray Maintainers `__ -- `Developer's Meeting `__ \ No newline at end of file +- `Developer's Meeting `__ From b518ff1060628b8b26b1ada57581d533a188e6c1 Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Thu, 20 Jun 2024 15:59:08 -0400 Subject: [PATCH 04/15] add change to whatsnew --- doc/whats-new.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/whats-new.rst b/doc/whats-new.rst index e7a48458ae2..200fca225f2 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -39,7 +39,8 @@ Bug fixes Documentation ~~~~~~~~~~~~~ - +- Adds a flow-chart diagram to help users navigate help resources (:discussion:`8990`). + By `Jessica Scheick `_. Internal Changes ~~~~~~~~~~~~~~~~ From 1a40ef86bd3124f83d0d346f7397822716a30918 Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Thu, 20 Jun 2024 16:52:54 -0400 Subject: [PATCH 05/15] add direct link to discussion and fix indent --- doc/getting-started-guide/help-diagram.rst | 87 +++++++++++----------- doc/whats-new.rst | 2 +- 2 files changed, 44 insertions(+), 45 deletions(-) diff --git a/doc/getting-started-guide/help-diagram.rst b/doc/getting-started-guide/help-diagram.rst index 5fb8d95179a..0a2ef29b0c4 100644 --- a/doc/getting-started-guide/help-diagram.rst +++ b/doc/getting-started-guide/help-diagram.rst @@ -7,62 +7,62 @@ The links to each resource are provided below the diagram. Regardless of how you interact with us, we're always thrilled to hear from you! .. mermaid:: ---- -title: Navigating Xarray Resources ---- + --- + title: Navigating Xarray Resources + --- -flowchart TD - intro[Welcome to Xarray! How can we help?]:::quesNodefmt - usage([fa:fa-chalkboard-user Xarray Tutorials - fab:fa-readme Xarray Docs - fab:fa-google Google/fab:fa-stack-overflow Stack Exchange]):::ansNodefmt - API([fab:fa-readme Xarray Docs - fab:fa-readme extension's docs]):::ansNodefmt - help([fab:fa-github Xarray Discussions - fab:fa-discord Xarray Discord - fa:fa-users Xarray Office Hours - fa:fa-globe Pangeo Discourse]):::ansNodefmt - bug([Report and Propose here: - fab:fa-github Xarray Issues]):::ansNodefmt - contrib([fa:fa-book-open Xarray Contributor's Guide]):::ansNodefmt - pr(["fab:fa-github Pull Request (PR)"]):::ansNodefmt - dev([fab:fa-github '@' Ping a Maintainer - fa:fa-users Developer's Meeting]):::ansNodefmt - report[Thanks for letting us know!]:::quesNodefmt - merged[Woohoo! Your PR was merged!]:::quesNodefmt + flowchart TD + intro[Welcome to Xarray! How can we help?]:::quesNodefmt + usage([fa:fa-chalkboard-user Xarray Tutorials + fab:fa-readme Xarray Docs + fab:fa-google Google/fab:fa-stack-overflow Stack Exchange]):::ansNodefmt + API([fab:fa-readme Xarray Docs + fab:fa-readme extension's docs]):::ansNodefmt + help([fab:fa-github Xarray Discussions + fab:fa-discord Xarray Discord + fa:fa-users Xarray Office Hours + fa:fa-globe Pangeo Discourse]):::ansNodefmt + bug([Report and Propose here: + fab:fa-github Xarray Issues]):::ansNodefmt + contrib([fa:fa-book-open Xarray Contributor's Guide]):::ansNodefmt + pr(["fab:fa-github Pull Request (PR)"]):::ansNodefmt + dev([fab:fa-github '@' Ping a Maintainer + fa:fa-users Developer's Meeting]):::ansNodefmt + report[Thanks for letting us know!]:::quesNodefmt + merged[Woohoo! Your PR was merged!]:::quesNodefmt - intro -->|How do I use Xarray?| usage - usage -->|"with extensions (like Dask)"| API + intro -->|How do I use Xarray?| usage + usage -->|"with extensions (like Dask)"| API - usage -->|I'd like some more help| help - intro -->|I found a bug or typo| bug - subgraph bugcontrib[Bugs and Contributions] - bug - contrib - bug -->|I just wanted to tell you| report - bug<-->|I'd like to fix the bug!| contrib - bug<-->|my plan was approved!| contrib + usage -->|I'd like some more help| help + intro -->|I found a bug or typo| bug + subgraph bugcontrib[Bugs and Contributions] + bug + contrib + bug -->|I just wanted to tell you| report + bug<-->|I'd like to fix the bug!| contrib + bug<-->|my plan was approved!| contrib - end + end - intro -->|I wish Xarray could...| bug + intro -->|I wish Xarray could...| bug - pr -->|my PR was approved| merged + pr -->|my PR was approved| merged - pr -->|my PR is quiet| dev - bug -->|my issue is quiet| dev - contrib -->pr + pr -->|my PR is quiet| dev + bug -->|my issue is quiet| dev + contrib -->pr - classDef quesNodefmt fill:#9DEEF4,stroke:#206C89 + classDef quesNodefmt fill:#9DEEF4,stroke:#206C89 - classDef ansNodefmt fill:#FFAA05,stroke:#E37F17 + classDef ansNodefmt fill:#FFAA05,stroke:#E37F17 - classDef boxfmt fill:#FFF5ED,stroke:#E37F17 - class bugcontrib boxfmt + classDef boxfmt fill:#FFF5ED,stroke:#E37F17 + class bugcontrib boxfmt - linkStyle default font-size:20pt,color:#206C89 + linkStyle default font-size:20pt,color:#206C89 - `Xarray Tutorials `__ @@ -74,5 +74,4 @@ flowchart TD - `Pangeo Discourse `__ - `Xarray Issues `__ - `Xarray Contributors Guide `__ -- `Xarray Maintainers `__ - `Developer's Meeting `__ diff --git a/doc/whats-new.rst b/doc/whats-new.rst index 200fca225f2..e8ddd2ea58d 100644 --- a/doc/whats-new.rst +++ b/doc/whats-new.rst @@ -39,7 +39,7 @@ Bug fixes Documentation ~~~~~~~~~~~~~ -- Adds a flow-chart diagram to help users navigate help resources (:discussion:`8990`). +- Adds a flow-chart diagram to help users navigate help resources (`Discussion #8990 `_). By `Jessica Scheick `_. Internal Changes From b1b8957bbf126b9d124deab1320689b0657bd437 Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Fri, 21 Jun 2024 11:02:48 -0400 Subject: [PATCH 06/15] remove title;add alt text --- doc/getting-started-guide/help-diagram.rst | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/doc/getting-started-guide/help-diagram.rst b/doc/getting-started-guide/help-diagram.rst index 0a2ef29b0c4..2be4760a164 100644 --- a/doc/getting-started-guide/help-diagram.rst +++ b/doc/getting-started-guide/help-diagram.rst @@ -7,9 +7,7 @@ The links to each resource are provided below the diagram. Regardless of how you interact with us, we're always thrilled to hear from you! .. mermaid:: - --- - title: Navigating Xarray Resources - --- + :alt: Flowchart illustrating the different ways to access help using or contributing to Xarray. flowchart TD intro[Welcome to Xarray! How can we help?]:::quesNodefmt @@ -43,10 +41,8 @@ Regardless of how you interact with us, we're always thrilled to hear from you! bug -->|I just wanted to tell you| report bug<-->|I'd like to fix the bug!| contrib bug<-->|my plan was approved!| contrib - end - intro -->|I wish Xarray could...| bug pr -->|my PR was approved| merged From adcf69f38551d29cd07044d23245a51760fe0ea7 Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Fri, 21 Jun 2024 11:35:02 -0400 Subject: [PATCH 07/15] update diagram lines for small contribs --- doc/getting-started-guide/help-diagram.rst | 26 ++++++++++++---------- 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/doc/getting-started-guide/help-diagram.rst b/doc/getting-started-guide/help-diagram.rst index 2be4760a164..2bf6889b5f0 100644 --- a/doc/getting-started-guide/help-diagram.rst +++ b/doc/getting-started-guide/help-diagram.rst @@ -1,5 +1,5 @@ -Getting help-diagram -==================== +Getting Help +============ Navigating the wealth of resources available for Xarray can be overwhelming. We've created this flow chart to help guide you towards the best way to get help, depending on what you're working towards. @@ -11,9 +11,10 @@ Regardless of how you interact with us, we're always thrilled to hear from you! flowchart TD intro[Welcome to Xarray! How can we help?]:::quesNodefmt - usage([fa:fa-chalkboard-user Xarray Tutorials + usage(["fa:fa-chalkboard-user Xarray Tutorials fab:fa-readme Xarray Docs - fab:fa-google Google/fab:fa-stack-overflow Stack Exchange]):::ansNodefmt + fab:fa-google Google/fab:fa-stack-overflow Stack Exchange + fa:fa-robot Ask AI/a Language Learning Model (LLM)"]):::ansNodefmt API([fab:fa-readme Xarray Docs fab:fa-readme extension's docs]):::ansNodefmt help([fab:fa-github Xarray Discussions @@ -24,31 +25,32 @@ Regardless of how you interact with us, we're always thrilled to hear from you! fab:fa-github Xarray Issues]):::ansNodefmt contrib([fa:fa-book-open Xarray Contributor's Guide]):::ansNodefmt pr(["fab:fa-github Pull Request (PR)"]):::ansNodefmt - dev([fab:fa-github '@' Ping a Maintainer + dev([fab:fa-github Comment on your PR fa:fa-users Developer's Meeting]):::ansNodefmt report[Thanks for letting us know!]:::quesNodefmt - merged[Woohoo! Your PR was merged!]:::quesNodefmt + merged[fa:fa-hands-clapping Your PR was merged. + Thanks for contributing to Xarray!]:::quesNodefmt intro -->|How do I use Xarray?| usage usage -->|"with extensions (like Dask)"| API usage -->|I'd like some more help| help - intro -->|I found a bug or typo| bug + intro -->|I found a bug| bug + intro -->|I'd like to make a small change| contrib subgraph bugcontrib[Bugs and Contributions] bug contrib bug -->|I just wanted to tell you| report bug<-->|I'd like to fix the bug!| contrib - bug<-->|my plan was approved!| contrib + pr -->|my PR was approved| merged end - intro -->|I wish Xarray could...| bug - pr -->|my PR was approved| merged + intro -->|I wish Xarray could...| bug - pr -->|my PR is quiet| dev - bug -->|my issue is quiet| dev + + pr <-->|my PR is quiet| dev contrib -->pr classDef quesNodefmt fill:#9DEEF4,stroke:#206C89 From b2188043ba5306bfdfd185cb0f266e742f05925c Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Fri, 21 Jun 2024 11:41:35 -0400 Subject: [PATCH 08/15] reorder extensions --- doc/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 8ac96c51a10..51c5670a653 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -68,7 +68,10 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. + +# sphinxcontrib.mermaid should go first or the diagram will not render (https://github.com/mgaitan/sphinxcontrib-mermaid/issues/124) extensions = [ + "sphinxcontrib.mermaid", "sphinx.ext.autodoc", "sphinx.ext.autosummary", "sphinx.ext.intersphinx", @@ -85,7 +88,6 @@ "sphinxext.rediraffe", "sphinx_design", "sphinx_inline_tabs", - "sphinxcontrib.mermaid", ] From 480346f7954a97a00d981c084f15c65575f86d9d Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 21 Jun 2024 15:45:38 +0000 Subject: [PATCH 09/15] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- doc/getting-started-guide/help-diagram.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/getting-started-guide/help-diagram.rst b/doc/getting-started-guide/help-diagram.rst index 2bf6889b5f0..a42a2f0936a 100644 --- a/doc/getting-started-guide/help-diagram.rst +++ b/doc/getting-started-guide/help-diagram.rst @@ -49,7 +49,7 @@ Regardless of how you interact with us, we're always thrilled to hear from you! intro -->|I wish Xarray could...| bug - + pr <-->|my PR is quiet| dev contrib -->pr From f6d8913e9cf9a289995c7d582011d1c909ca217b Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Fri, 21 Jun 2024 12:56:28 -0400 Subject: [PATCH 10/15] add nbsphinx_requirejs_path config value --- doc/conf.py | 2 +- doc/getting-started-guide/index.rst | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 51c5670a653..7df97fd4e51 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -59,6 +59,7 @@ ) nbsphinx_allow_errors = False +nbsphinx_requirejs_path = '' # -- General configuration ------------------------------------------------ @@ -69,7 +70,6 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -# sphinxcontrib.mermaid should go first or the diagram will not render (https://github.com/mgaitan/sphinxcontrib-mermaid/issues/124) extensions = [ "sphinxcontrib.mermaid", "sphinx.ext.autodoc", diff --git a/doc/getting-started-guide/index.rst b/doc/getting-started-guide/index.rst index b08b0be0fc7..20fd49fb2c4 100644 --- a/doc/getting-started-guide/index.rst +++ b/doc/getting-started-guide/index.rst @@ -13,4 +13,3 @@ It is designed as an entry point for new users, and it provided an introduction installing quick-overview faq - help-diagram From 893ea47ca0bd997bc3ec0da7e089bdf6800a99b2 Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Fri, 21 Jun 2024 12:57:31 -0400 Subject: [PATCH 11/15] move help page up a level in toc --- doc/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/index.rst b/doc/index.rst index 6ef6c62864a..4a5fe4ee080 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -66,6 +66,7 @@ efficient, and fun! Tutorials & Videos API Reference How do I ... + Getting Help Ecosystem .. toctree:: From dc2227aab6eba1bf3d85e57a3427452ba2d36236 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 21 Jun 2024 16:59:45 +0000 Subject: [PATCH 12/15] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 7df97fd4e51..e7c4145cefc 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -59,7 +59,7 @@ ) nbsphinx_allow_errors = False -nbsphinx_requirejs_path = '' +nbsphinx_requirejs_path = "" # -- General configuration ------------------------------------------------ From 55f14ca63994705cf4fe9546628b311390ee28c9 Mon Sep 17 00:00:00 2001 From: Jessica Scheick Date: Fri, 21 Jun 2024 13:29:41 -0400 Subject: [PATCH 13/15] move file to correct level --- doc/{getting-started-guide => }/help-diagram.rst | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/{getting-started-guide => }/help-diagram.rst (100%) diff --git a/doc/getting-started-guide/help-diagram.rst b/doc/help-diagram.rst similarity index 100% rename from doc/getting-started-guide/help-diagram.rst rename to doc/help-diagram.rst From 38c8173296680513e8093ffc11f1de7913ebe556 Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Sat, 22 Jun 2024 16:20:17 -0600 Subject: [PATCH 14/15] Bump mermaid version --- doc/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/conf.py b/doc/conf.py index e7c4145cefc..91bcdf8b8f8 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -178,6 +178,8 @@ "pd.NaT": "~pandas.NaT", } +# mermaid config +mermaid_version = "10.9.1" # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates", sphinx_autosummary_accessors.templates_path] From 0d3f66712bee82a5c896fef6cde9eba0d07fcdf6 Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Sat, 22 Jun 2024 16:21:15 -0600 Subject: [PATCH 15/15] [skip-ci]