|
| 1 | +####################################################################################### |
| 2 | +# A default configuration that will be loaded for all jupyter books |
| 3 | +# Users are expected to override these values in their own `_config.yml` file. |
| 4 | +# This is also the "master list" of all allowed keys and values. |
| 5 | + |
| 6 | +####################################################################################### |
| 7 | +# Book settings |
| 8 | +title : Handbook |
| 9 | +author : Michael Bornholdt, Juan Caicedo, Yu Han, Nikita Moshkov, Rebecca Senft (in alphabetical order) |
| 10 | +copyright : "2022" # Copyright year to be placed in the footer |
| 11 | +logo : "images/banner.png" # A path to the book logo |
| 12 | +# Patterns to skip when building the book. Can be glob-style (e.g. "*skip.ipynb") |
| 13 | +exclude_patterns : [_build, Thumbs.db, .DS_Store, "**.ipynb_checkpoints"] |
| 14 | +# Auto-exclude files not in the toc |
| 15 | +only_build_toc_files : false |
| 16 | + |
| 17 | +####################################################################################### |
| 18 | +# Execution settings |
| 19 | +execute: |
| 20 | + execute_notebooks : auto # Whether to execute notebooks at build time. Must be one of ("auto", "force", "cache", "off") |
| 21 | + cache : "" # A path to the jupyter cache that will be used to store execution artifacts. Defaults to `_build/.jupyter_cache/` |
| 22 | + exclude_patterns : [] # A list of patterns to *skip* in execution (e.g. a notebook that takes a really long time) |
| 23 | + timeout : 30 # The maximum time (in seconds) each notebook cell is allowed to run. |
| 24 | + run_in_temp : false # If `True`, then a temporary directory will be created and used as the command working directory (cwd), |
| 25 | + # otherwise the notebook's parent directory will be the cwd. |
| 26 | + allow_errors : false # If `False`, when a code cell raises an error the execution is stopped, otherwise all cells are always run. |
| 27 | + stderr_output : show # One of 'show', 'remove', 'remove-warn', 'warn', 'error', 'severe' |
| 28 | + |
| 29 | + |
| 30 | +####################################################################################### |
| 31 | +# HTML-specific settings |
| 32 | +html: |
| 33 | + favicon : "images/favicon_32.png" # A path to a favicon image |
| 34 | + 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 |
| 35 | + use_repository_button : true # Whether to add a link to your repository button |
| 36 | + use_issues_button : true # Whether to add an "open an issue" button |
| 37 | + use_multitoc_numbering : true # Continuous numbering across parts/chapters |
| 38 | + extra_navbar : Powered by <a href="https://jupyterbook.org">Jupyter Book</a> # Will be displayed underneath the left navbar. |
| 39 | + extra_footer : "" # Will be displayed underneath the footer. |
| 40 | + google_analytics_id : "" # A GA id that can be used to track book views. |
| 41 | + home_page_in_navbar : true # Whether to include your home page in the left Navigation Bar |
| 42 | + baseurl : "" # The base URL where your book will be hosted. Used for creating image previews and social links. e.g.: https://mypage.com/mybook/ |
| 43 | + comments: |
| 44 | + hypothesis : false |
| 45 | + utterances : false |
| 46 | + #google_analytics_id: UA-XXXXXXXXX-X |
| 47 | + |
| 48 | +####################################################################################### |
| 49 | +# LaTeX-specific settings |
| 50 | +latex: |
| 51 | + latex_engine : pdflatex # one of 'pdflatex', 'xelatex' (recommended for unicode), 'luatex', 'platex', 'uplatex' |
| 52 | + use_jupyterbook_latex : true # use sphinx-jupyterbook-latex for pdf builds as default |
| 53 | + |
| 54 | +####################################################################################### |
| 55 | +# Launch button settings |
| 56 | +launch_buttons: |
| 57 | + notebook_interface : classic # The interface interactive links will activate ["classic", "jupyterlab"] |
| 58 | + binderhub_url : https://mybinder.org # The URL of the BinderHub (e.g., https://mybinder.org) |
| 59 | + jupyterhub_url : "" # The URL of the JupyterHub (e.g., https://datahub.berkeley.edu) |
| 60 | + thebe : false # Add a thebe button to pages (requires the repository to run on Binder) |
| 61 | + colab_url : "" # The URL of Google Colab (https://colab.research.google.com) |
| 62 | + |
| 63 | +repository: |
| 64 | + url : https://github.com/cytomining/DeepProfiler-handbook # The URL to your book's repository |
| 65 | + path_to_book : "DeepProfiler-Handbook" # A path to your book's folder, relative to the repository root. |
| 66 | + branch : main # Which branch of the repository should be used when creating links |
| 67 | + |
| 68 | +####################################################################################### |
| 69 | +# Advanced and power-user settings |
| 70 | +sphinx: |
| 71 | + extra_extensions : # additional extensions, must be installed |
| 72 | + local_extensions : # A list of local extensions to load by sphinx specified by "name: path" items |
| 73 | + config : # key-value pairs to directly over-ride the Sphinx configuration |
0 commit comments