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

title: FEniCSx tutorial
author: Jørgen S. Dokken
logo: fenics_logo.png

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

  # Set timeout for any example to 20 minutes
  timeout: 1800
# Define the name of the latex output file for PDF builds
# latex:
#   latex_documents:
#     targetname: book.tex

# Information about where the book exists on the web
repository:
  url: https://github.com/jorgensd/dolfinx-tutorial # Online location of your book
  path_to_book: . # Optional path to your book, relative to the repository root
  branch: release # Which branch of the repository should be used when creating links (optional)

  # Add a bibtex file so that we can create citations
bibtex_bibfiles:
  - references.bib

launch_buttons:
  notebook_interface: "jupyterlab"
  binderhub_url: "https://mybinder.org"

sphinx:
  config:
    html_last_updated_fmt: "%b %d, %Y"
    suppress_warnings: ["mystnb.unknown_mime_type"]

    # To avoid warning about default changing due to
    # https://github.com/pydata/pydata-sphinx-theme/issues/1492
    # html_theme_options:
    #   navigation_with_keys: false
    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]

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

parse:
  myst_enable_extensions:
    - "amsmath"
    - "colon_fence"
    - "deflist"
    - "dollarmath"
    - "html_admonition"
    - "html_image"
    - "linkify"
    - "replacements"
    - "smartquotes"
    - "substitution"
# Add GitHub buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
html:
  use_issues_button: true
  use_repository_button: true
  use_edit_page_button: true

  extra_footer: |
    <div>
        This webpage is an adaptation of <a href=https://www.springer.com/gp/book/9783319524610>The FEniCS tutorial</a> and
        is distributed under the terms of the      <a href=http://creativecommons.org/licenses/by/4.0/>Creative Commons Attribution 4.0 International License  </a>
        which permits use, duplication, adaptation, distribution and reproduction in any medium or format, as long as you give appropriate credit to the original author(s) and the source,
        provide a link to the Creative Commons license and indicate if changes were made.
    </div>

exclude_patterns: [README.md, chapter2/advdiffreac.md]
only_build_toc_files: true