-
Notifications
You must be signed in to change notification settings - Fork 31
/
Copy path_config.yml
117 lines (104 loc) · 7.02 KB
/
_config.yml
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
#######################################################################################
# The NO Complexity default configuration configuration making jupyter books
# Override these values in their own `_config.yml` file.
# Created by Maikel Mardjan (nocomplexity.com)
#######################################################################################
# Book settings
title : 'Security Reference Architecture' # The title of the book. Will be placed in the left navbar.
author : '<a href="https://nocomplexity.com/">Maikel Mardjan (nocomplexity.com)</a> & Asim Jahan and all contributors.' # The author of the book
copyright : '2025 Business Management Support Foundation (bm-support.org)' # Copyright year to be placed in the footer
logo : "images/nocxbanner.png" # 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",README.md]
# Auto-exclude files not in the toc
only_build_toc_files : false
#######################################################################################
# Execution settings
execute:
execute_notebooks : auto # 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 artifacs. 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 : true # Whether to add an "open an issue" button
extra_footer : '<p><a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a> © Copyright 2025, <a href="https://bm-support.org/"> BM-Support.org</a> & Maikel Mardjan. This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.</p>'
extra_navbar : '<a href="https://bm-support.org/"><b>ROI Now!</b></a>'
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 : "" # 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 : jupyterlab # 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/nocomplexity/SecurityArchitecture # The URL to your book's repository
# path_to_book : "" # A path to your book's folder, relative to the repository root.
# branch : master # Which branch of the repository should be used when creating links
# repository:
# github_url: https://github.com/nocomplexity/SecurityArchitecture
# html:
# use_repository_button: true
# github_url: https://github.com/
# github_repo: SecurityArchitecture
# #######################################################################################
# Advanced and power-user settings
sphinx:
extra_extensions :
- sphinx_design
#- sphinx_click.ext
#- sphinx.ext.autodoc
#- sphinx.ext.viewcode
#- sphinx.ext.napoleon
#- sphinx.ext.todo
local_extensions : # A list of local extensions to load by sphinx specified by "name: path" items
# gitinfo : '/home/maikel/projects/pythondev/simple-ml-qacheck'
config:
html_last_updated_fmt: ""
html_theme_options:
repository_url: "https://github.com/nocomplexity/SecurityArchitecture"
repository_branch: "master"
use_repository_button: True
use_edit_page_button: True
use_issues_button: True
# home_page_in_toc: False,
logo:
text: 'Open Security Reference Architecture'
extra_footer: '<p><a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a> This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.</p>'
parse:
myst_enable_extensions:
- html_admonition