diff --git a/doc/conf.py b/doc/conf.py index 4c1c7482247..b7a63ebcc57 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -6,7 +6,7 @@ import sys from contextlib import suppress from textwrap import dedent, indent - +import packaging.version import sphinx_autosummary_accessors import yaml from sphinx.application import Sphinx @@ -185,7 +185,7 @@ autodoc_type_aliases = napoleon_type_aliases # Keep both in sync # mermaid config -mermaid_version = "10.9.1" +mermaid_version = "11.6.0" # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates", sphinx_autosummary_accessors.templates_path] @@ -201,10 +201,9 @@ project = "xarray" copyright = f"2014-{datetime.datetime.now().year}, xarray Developers" -# The short X.Y version. -version = xarray.__version__.split("+")[0] -# The full version, including alpha/beta/rc tags. -release = xarray.__version__ +# The short Y.M.D version. +v = packaging.version.parse(xarray.__version__) +version = ".".join(str(p) for p in v.release) # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -314,6 +313,7 @@ "installing.rst": "getting-started-guide/installing.rst", "quick-overview.rst": "getting-started-guide/quick-overview.rst", "contributing.rst": "contribute/contributing.rst", + "developers-meeting.rst": "contribute/developers-meeting.rst", } # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, diff --git a/doc/get-help/help-diagram.rst b/doc/get-help/help-diagram.rst index 9ee07426e95..87fbc0edbb4 100644 --- a/doc/get-help/help-diagram.rst +++ b/doc/get-help/help-diagram.rst @@ -3,53 +3,72 @@ 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. -The links to each resource are provided below the diagram. -Also be sure to check out our "FAQ" and "How do I..." pages in this section for solutions to common questions. +Also be sure to check out our :ref:`faq`. and :ref:`howdoi` pages for solutions to common questions. -A major strength of Xarray is in the user community. Sometimes you might not have a concrete question by would simply like to connect with other Xarray users. We have a few +A major strength of Xarray is in the user community. Sometimes you might not yet have a concrete question but would simply like to connect with other Xarray users. We have a few accounts on different social platforms for that! :ref:`socials`. We look forward to hearing from you! +Help Flowchart +-------------- +.. + _comment: mermaid Flowcharg "link" text gets secondary color background, SVG icon fill gets primary color + +.. raw:: html + + + .. mermaid:: + :config: {"theme":"base","themeVariables":{"fontSize":"20px","primaryColor":"#fff","primaryTextColor":"#fff","primaryBorderColor":"#59c7d6","lineColor":"#e28126","secondaryColor":"#767985"}} :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 - usage(["fa:fa-chalkboard-user Xarray Tutorials - fab:fa-readme Xarray Docs - 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 - 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 Comment on your PR - fa:fa-users Developer's Meeting]):::ansNodefmt + usage([fa:fa-chalkboard-user Xarray Tutorial + fab:fa-readme Xarray Docs + fab:fa-stack-overflow Stack Exchange + fab:fa-google Ask Google + fa:fa-robot Ask AI ChatBot]):::ansNodefmt + extensions([Extension docs: + fab:fa-readme Dask + fab:fa-readme Rioxarray]):::ansNodefmt + help([fab:fa-github Xarray Discussions + fab:fa-discord Xarray Discord + fa:fa-globe Pangeo Discourse]):::ansNodefmt + bug([Let us know: + fab:fa-github Xarray Issues]):::ansNodefmt + contrib([fa:fa-book-open Xarray Contributor's Guide]):::ansNodefmt + pr([fab:fa-github Pull Request]):::ansNodefmt + dev([fab:fa-github Add PR Comment + fa:fa-users Attend Developer's Meeting ]):::ansNodefmt report[Thanks for letting us know!]:::quesNodefmt - merged[fa:fa-hands-clapping Your PR was merged. - Thanks for contributing to Xarray!]:::quesNodefmt + merged[fa:fa-hands-clapping Thanks for contributing to Xarray!]:::quesNodefmt intro -->|How do I use Xarray?| usage - usage -->|"with extensions (like Dask)"| API + usage -->|"With extensions (like Dask, Rioxarray, etc.)"| extensions - usage -->|I'd like some more help| help - 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 - pr -->|my PR was approved| merged - end + usage -->|I still have questions or could use some guidance | help + intro -->|I think I found a bug| bug + bug + contrib + bug -->|I just wanted to tell you| report + bug<-->|I'd like to fix the bug!| contrib + pr -->|my PR was approved| merged intro -->|I wish Xarray could...| bug @@ -58,20 +77,16 @@ We look forward to hearing from you! pr <-->|my PR is quiet| dev contrib -->pr - classDef quesNodefmt fill:#9DEEF4,stroke:#206C89 - - classDef ansNodefmt fill:#FFAA05,stroke:#E37F17 + classDef quesNodefmt font-size:20pt,fill:#0e4666,stroke:#59c7d6,stroke-width:3 + classDef ansNodefmt font-size:18pt,fill:#4a4a4a,stroke:#17afb4,stroke-width:3 + linkStyle default font-size:16pt,stroke-width:4 - classDef boxfmt fill:#FFF5ED,stroke:#E37F17 - class bugcontrib boxfmt - - linkStyle default font-size:20pt,color:#206C89 Flowchart links --------------- - `Xarray Tutorials `__ - `Xarray Docs `__ -- `Google/Stack Exchange `__ +- `Stack Exchange `__ - `Xarray Discussions `__ - `Xarray Discord `__ - `Xarray Office Hours `__ @@ -80,7 +95,6 @@ Flowchart links - :ref:`contributing` - :ref:`developers-meeting` - .. toctree:: :maxdepth: 1 :hidden: