io4dolfinx/_config.yml at main · scientificcomputing/io4dolfinx · 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
# Book settings
# Learn more at https://jupyterbook.org/customize/config.html

title: ADIOS2Wrappers
author: Jørgen S. Dokken
logo: "docs/logo.png"
copyright: "2023"
only_build_toc_files: true

# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
  execute_notebooks: cache

# Information about where the book exists on the web
repository:
  url: https://github.com/scientificcomputing/io4dolfinx # Online location of your book
  branch: main

html:
  use_issues_button: true
  use_repository_button: true

parse:
  myst_enable_extensions:
    - amsmath
    - dollarmath
    - linkify

sphinx:
  extra_extensions:
    - "sphinx.ext.autodoc"
    - "sphinx.ext.napoleon"
    - "sphinx.ext.viewcode"
    - "sphinx.ext.intersphinx"
    - "sphinx_codeautolink"

  config:
    html_last_updated_fmt: "%b %d, %Y"
    nb_custom_formats:
      .py:
        - jupytext.reads
        - fmt: py

    autodoc_typehints: signature
    autodoc_typehints_format: short
    codeautolink_concat_default: True
    intersphinx_mapping:
      basix: ["https://docs.fenicsproject.org/basix/main/python", null]
      ffcx: ["https://docs.fenicsproject.org/ffcx/main", null]
      ufl: ["https://docs.fenicsproject.org/ufl/main", null]
      dolfinx: ["https://docs.fenicsproject.org/dolfinx/main/python", null]
      petsc4py: ["https://petsc.org/release/petsc4py", null]
      mpi4py: ["https://mpi4py.readthedocs.io/en/stable", null]
      numpy: ["https://numpy.org/doc/stable/", null]
      pyvista: ["https://docs.pyvista.org/", null]
      packaging: ["https://packaging.pypa.io/en/stable/", null]
      matplotlib: ["https://matplotlib.org/stable/", null]
      ipyparallel: ["https://ipyparallel.readthedocs.io/en/stable/", null]
      python: ["https://docs.python.org/3", null]
      h5py: ["https://docs.h5py.org/en/stable/", null]
      adios2: ["https://adios2.readthedocs.io/en/latest", null]

exclude_patterns: [".pytest_cache/*"]