_config.yml

# Book settings
title                       : Pathy  # The title of the book. Will be placed in the left navbar.
author                      : Pieter Fiers, Simon Germeau  # The author of the book
# copyright                   : "2020"  # Copyright year to be placed in the footer
# logo                        : ""  # A path to the book logo
# Patterns to skip when building the book. Can be glob-style (e.g. "*skip.ipynb")
exclude_patterns            : [_build, Thumbs.db, .DS_Store, "**.ipynb_checkpoints", "env-pathy", env]
# Auto-exclude files not in the toc
only_build_toc_files        : false

#######################################################################################
# Execution settings
execute:
  execute_notebooks         : off  # Whether to execute notebooks at build time. Must be one of ("auto", "force", "cache", "off")
  # cache                     : ""    # A path to the jupyter cache that will be used to store execution artifacts. Defaults to `_build/.jupyter_cache/`
  # exclude_patterns          : []    # A list of patterns to *skip* in execution (e.g. a notebook that takes a really long time)
  # timeout                   : 30    # The maximum time (in seconds) each notebook cell is allowed to run.
  # run_in_temp               : false # If `True`, then a temporary directory will be created and used as the command working directory (cwd),
  #                                   # otherwise the notebook's parent directory will be the cwd.
  # allow_errors              : false # If `False`, when a code cell raises an error the execution is stopped, otherwise all cells are always run.
  # stderr_output             : show  # One of 'show', 'remove', 'remove-warn', 'warn', 'error', 'severe'

#######################################################################################
# Parse and render settings
# parse:
#   myst_enable_extensions:  # default extensions to enable in the myst parser. See https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html
#     # - amsmath
#     - colon_fence
#     # - deflist
#     - dollarmath
#     # - html_admonition
#     # - html_image
#     - linkify
#     # - replacements
#     # - smartquotes
#     - substitution

#   myst_url_schemes          : [mailto, http, https]  # URI schemes that will be recognised as external URLs in Markdown links

#######################################################################################
# HTML-specific settings
html:
#   favicon                   : ""  # A path to a favicon image
  use_edit_page_button      : true  # Whether to add an "edit this page" button to pages. If `true`, repository information in repository: must be filled in
  use_repository_button     : true  # Whether to add a link to your repository button
#   use_issues_button         : false  # Whether to add an "open an issue" button
#   extra_navbar              : Powered by <a href="https://jupyterbook.org">Jupyter Book</a>  # Will be displayed underneath the left navbar.
#   extra_footer              : ""  # Will be displayed underneath the footer.
#   google_analytics_id       : ""  # A GA id that can be used to track book views.
  home_page_in_navbar       : true  # Whether to include your home page in the left Navigation Bar
  baseurl                   : "https://pathy.pfiers.net/"  # The base URL where your book will be hosted. Used for creating image previews and social links. e.g.: https://mypage.com/mybook/
#   comments:
#     hypothesis              : false
#     utterances              : false

#######################################################################################
# LaTeX-specific settings
# latex:
#   latex_engine              : pdflatex  # one of 'pdflatex', 'xelatex' (recommended for unicode), 'luatex', 'platex', 'uplatex'

#######################################################################################
# Launch button settings
# launch_buttons:
#   notebook_interface        : classic  # The interface interactive links will activate ["classic", "jupyterlab"]
#   binderhub_url             : https://mybinder.org  # The URL of the BinderHub (e.g., https://mybinder.org)
#   jupyterhub_url            : ""  # The URL of the JupyterHub (e.g., https://datahub.berkeley.edu)
#   thebe                     : false  # Add a thebe button to pages (requires the repository to run on Binder)
#   colab_url                 : "" # The URL of Google Colab (https://colab.research.google.com)

repository:
  url                       : https://github.com/ubipo/pathy
  branch                    : master

sphinx:
  extra_extensions:
    - include_in_output
  config:
    nb_custom_formats:
      .py:
        - sphinx_py_conv.py_to_nb_node
        - ext: ".py"