sc2ts/docs/_config.yml at 50fdf477bd488eb5fa0b6914b8c9c59ad5af9264 · tskit-dev/sc2ts · 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
# Book settings
# Learn more at https://jupyterbook.org/customize/config.html

title: sc2ts manual
author: sc2ts developers
logo: sc2ts.png
copyright: "2025"
only_build_toc_files: true

execute:
  execute_notebooks: cache

launch_buttons:
  binderhub_url: ""

repository:
  url: https://github.com/tskit-dev/sc2ts
  branch: main
  path_to_book: docs

html:
  favicon: sc2ts.png
  use_issues_button: true
  use_repository_button: true
  use_edit_page_button: true

sphinx:
  extra_extensions:
    - sphinx_copybutton
    - sphinx.ext.autodoc
    - sphinx.ext.autosummary
    - sphinx.ext.todo
    - sphinx.ext.viewcode
    - sphinx.ext.intersphinx
    - sphinx_issues
    - sphinxarg.ext
    - IPython.sphinxext.ipython_console_highlighting
    - sphinx_click.ext

  config:
    html_theme: sphinx_book_theme
    html_theme_options:
      navigation_with_keys: false
      pygments_dark_style: monokai
      logo:
        text: "Version __PKG_VERSION__"

    myst_enable_extensions:
      - colon_fence
      - deflist
      - substitution

    issues_github_path: tskit-dev/sc2ts
    todo_include_todos: true

    intersphinx_mapping:
      python: ["https://docs.python.org/3/", null]
      tskit: ["https://tskit.dev/tskit/docs/stable", null]
      tutorials: ["https://tskit.dev/tutorials/", null]
      numpy: ["https://numpy.org/doc/stable/", null]
      pandas: ["https://pandas.pydata.org/docs/", null]

    nitpicky: true

    autodoc_member_order: bysource
    autodoc_typehints: none

    myst_substitutions:
      min_python_version: "3.10"