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

title: "Technical documentation of the PDSSP project"
author: Jérôme Gasperi, Jean-Christophe Malapert, Nicolas Manaud
logo: images/pdssp_logo.png

# Sphinx extension
sphinx:
  extra_extensions:
   - 'sphinx.ext.autodoc'
   - 'sphinx.ext.napoleon'
   - 'sphinx.ext.viewcode'
   - 'sphinx.ext.intersphinx'
   - 'sphinxcontrib.autodoc_pydantic'
   - 'sphinxcontrib.bibtex'
  config:
    bibtex_reference_style: author_year
# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
  execute_notebooks: force

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

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

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

# Add GitHub buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
html:
  favicon: images/favicon.png
  use_issues_button: true
  use_repository_button: true
  home_page_in_navbar: false

parse:
  myst_substitutions:
    external_link: '{octicon}`link-external;1em;sd-text-secondary`'
    # Statuses
    no_status: ''
    indev_status: '{bdg-warning-line}`in development`'
    # PDSSP Web Interface
    pdss_web_status: '{{ no_status }}'
    pdssp_web_link: '[https://pdssp.ias.universite-paris-saclay.fr](https://pdssp.ias.universite-paris-saclay.fr) {octicon}`link-external;1em;sd-text-secondary` {{ pdss_web_status }}'
    pdssp_web_nlink: '[PDSSP Web Interface](https://pdssp.ias.universite-paris-saclay.fr) {octicon}`link-external;1em;sd-text-secondary` {{ pdss_web_status }}'
    # PDSSP JupyterHub
    pdss_jhub_status: '{{ indev_status }}'
    pdssp_jhub_link: '[https://pdssp.ias.universite-paris-saclay.fr/jupyterhub](https://pdssp.ias.universite-paris-saclay.fr/jupyterhub) {octicon}`link-external;1em;sd-text-secondary` {{ pdss_jhub_status }}'
    pdssp_jhub_nlink: '[PDSSP JupyterHub](https://pdssp.ias.universite-paris-saclay.fr/jupyterhub) {octicon}`link-external;1em;sd-text-secondary` {{ pdss_jhub_status }}'
    # PDSSP Crawler
    pdss_crawler_status: '{{ indev_status }}'
    pdssp_crawler_link: '[https://pdssp.ias.universite-paris-saclay.fr/crawler](https://pdssp.ias.universite-paris-saclay.fr/crawler) {octicon}`link-external;1em;sd-text-secondary` {{ pdss_crawler_status }}'
    pdssp_crawler_nlink: '[PDSSP Crawler](https://pdssp.ias.universite-paris-saclay.fr/crawler) {octicon}`link-external;1em;sd-text-secondary` {{ pdss_crawler_status }}'
    # PDSSP RegistryInterface
    pdss_registry_status: '{{ no_status }}'
    pdssp_registry_link: '[https://ping-pdssp.ias.universite-paris-saclay.fr](https://ping-pdssp.ias.universite-paris-saclay.fr/) {octicon}`link-external;1em;sd-text-secondary` {{ pdss_registry_status }}'
    pdssp_registry_nlink: '[PDSSP RegistryInterface](https://ping-pdssp.ias.universite-paris-saclay.fr) {octicon}`link-external;1em;sd-text-secondary` {{ pdss_registry_status }}'