xarray-tutorial/_config.yml at 2e3e0f53e0b297d506c5a8b54edecd5bbf073330 · xarray-contrib/xarray-tutorial · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# Learn more at https://jupyterbook.org/customize/config.html
title: ""
author: The Xarray Community
copyright: "2024"
logo: images/logo.png
only_build_toc_files: true

# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
html:
  # NOTE: this announcement shows up on all pages
  announcement: '<a href="https://forms.gle/KEq7WviCdz9xTaJX6">The Xarray 2024 User Survey is live. Please take ~5 minutes to fill it out and help us improve Xarray.</a>'
  #announcement: 'ℹ️ SciPy 2024 Tutorial Attendees. <a href="https://tutorial.xarray.dev/workshops/scipy2024/README.html">Click here </a>.'
  home_page_in_navbar: false
  use_edit_page_button: true
  use_issues_button: true
  use_repository_button: true
  google_analytics_id: G-JRQHYVFQR7
  extra_footer: '<p>Xarray is a fiscally sponsored project of <a href="https://numfocus.org">NumFOCUS</a>, a nonprofit dedicated to supporting the open-source scientific computing community.<br> Theme by the <a href="https://ebp.jupyterbook.org">Executable Book Project</a>.</p> Content licensed under the terms of the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0 License</a>.'

parse:
  # https://jupyterbook.org/content/content-blocks.html?highlight=myst%20substitution#define-substitutions-for-your-whole-book
  # https://jupyterbook.org/content/content-blocks.html#using-substitutions-in-links
  myst_substitutions:
    xarray_homepage: https://xarray.dev
    xarray_docs: https://docs.xarray.dev
    xarray_repo: https://github.com/pydata/xarray
    xarray_forum: https://github.com/pydata/xarray/discussions
  myst_enable_extensions:
    # Defaults
    - dollarmath
    - linkify
    - substitution
    - colon_fence
    # Extras
    - html_image

# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
  execute_notebooks: "cache"
  allow_errors: false
  # Per-cell notebook execution limit (seconds)
  timeout: 300

# Define the name of the latex output file for PDF builds
latex:
  latex_documents:
    targetname: book.tex

# Configure your Binder links, such as the URL of the BinderHub.
launch_buttons:
  notebook_interface: jupyterlab
  binderhub_url: "https://mybinder.org"

# Information about where the book exists on the web
repository:
  url: "https://github.com/xarray-contrib/xarray-tutorial"
  branch: main

# Bibliography
bibtex_bibfiles:
  - reference/references.bib

# Advanced configuration
sphinx:
  extra_extensions:
    # 404 not found page
    - notfound.extension
    # maintain old paths and redirect them (so google results dont go to 404)
    # https://github.com/wpilibsuite/sphinxext-rediraffe
    - sphinxext.rediraffe
    - sphinx_codeautolink

  config:
    language: en # accessibility
    # application/vnd.holoviews_load.v0+json, application/vnd.holoviews_exec.v0+json
    suppress_warnings: ["mystnb.unknown_mime_type", "misc.highlighting_failure"]
    codeautolink_concat_default: True
    codeautolink_warn_on_missing_inventory: True
    codeautolink_warn_on_failed_resolve: True
    codeautolink_inventory_map: {
        # unfortunately mapping the top level doesn't work, need all methods
        #"xarray.core.dataarray.DataArray": "xarray.DataArray",
        "xarray.core.accessor_dt.DatetimeAccessor": "xarray.DataArray.dt",
        "xarray.core.dataarray.DataArray.coarsen": "xarray.DataArray.coarsen",
        "xarray.core.dataarray.DataArray.groupby": "xarray.DataArray.groupby",
        "xarray.core.dataarray.DataArray.groupby_bins": "xarray.DataArray.groupby_bins",
        "xarray.core.dataarray.DataArray.isel": "xarray.DataArray.isel",
        #"xarray.core.dataarray.DataArray.plot": "xarray.DataArray.plot",
        "xarray.plot.accessor.DataArrayPlotAccessor": "xarray.DataArray.plot",
        "xarray.core.dataarray.DataArray.redindex": "xarray.DataArray.reindex",
        "xarray.core.dataarray.DataArray.reduce": "xarray.DataArray.reduce",
        "xarray.core.dataarray.DataArray.resample": "xarray.DataArray.resample",
        "xarray.core.dataarray.DataArray.rolling": "xarray.DataArray.rolling",
        "xarray.core.dataarray.DataArray.sel": "xarray.DataArray.sel",
        "xarray.core.dataarray.DataArray.weighted": "xarray.DataArray.weighted",
        #"Same for dataset :(
        "xarray.core.dataset.Dataset.groupby": "xarray.Dataset.groupby",
        "xarray.core.dataset.Dataset.isel": "xarray.Dataset.sel",
      }
    notfound_context:
      body: "<h1>Whoops! 404 Page Not Found</h1>\n\n<p>Sorry, this page doesn't exist. Many sections of this book have been updated recently.</p><p> Try the search box 🔎 to find what you're looking for!</p>"
    notfound_urls_prefix: /
    rediraffe_redirects:
      scipy-tutorial/00_overview.ipynb: overview/get-started.md
      workshops/scipy2022/README.md: overview/fundamental-path/README.md
      fundamentals/02.1_working_with_labeled_data.ipynb: fundamentals/02.1_indexing_Basic.ipynb

    bibtex_reference_style: author_year # or label, super, \supercite

    intersphinx_mapping:
      xarray:
        - https://docs.xarray.dev/en/latest/
        - null
      numpy:
        - https://numpy.org/doc/stable
        - null
      scipy:
        - https://docs.scipy.org/doc/scipy
        - null
      matplotlib:
        - https://matplotlib.org/stable/
        - null
      dask:
        - https://docs.dask.org/en/latest
        - null
      python:
        - https://docs.python.org/3/
        - null
      pandas:
        - https://pandas.pydata.org/pandas-docs/stable
        - null