Skip to content

Commit b8a9e93

Browse files
committed
Added _config.yml
1 parent d17e65d commit b8a9e93

File tree

1 file changed

+107
-0
lines changed

1 file changed

+107
-0
lines changed

docs/book/_config.yml

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
####################################################
2+
# Computational Methods for Economists using Python,
3+
# Jupyter Book documentation settings
4+
####################################################
5+
title : Computational Methods for Economists using Python
6+
author : Richard W. Evans
7+
copyright : '2023'
8+
logo : '..//CompMethodsLogo_horizontal.png'
9+
10+
####################################################
11+
# Execution settings
12+
execute:
13+
execute_notebooks: force
14+
timeout: -1
15+
16+
#######################################################################################
17+
# Parse and render settings
18+
parse:
19+
myst_enable_extensions: # default extensions to enable in the myst parser. See https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html
20+
- amsmath
21+
- colon_fence
22+
# - deflist
23+
- dollarmath
24+
# - html_admonition
25+
# - html_image
26+
- linkify
27+
# - replacements
28+
# - smartquotes
29+
- substitution
30+
- tasklist
31+
- html_image
32+
myst_url_schemes: [mailto, http, https] # URI schemes that will be recognised as external URLs in Markdown links
33+
myst_dmath_double_inline: true # Allow display math ($$) within an inline context
34+
35+
####################################################
36+
# HTML-specific settings
37+
html:
38+
favicon : "..//favicon.ico" # A path to a favicon image
39+
use_edit_page_button : false # Whether to add an "edit this page" button to pages. If `true`, repository information in repository: must be filled in
40+
use_repository_button : true # Whether to add a link to your repository button
41+
use_issues_button : true # Whether to add an "open an issue" button
42+
use_multitoc_numbering : true # Continuous numbering across parts/chapters
43+
extra_navbar : Powered by <a href="https://jupyterbook.org">Jupyter Book</a> # Will be displayed underneath the left navbar.
44+
extra_footer : "" # Will be displayed underneath the footer.
45+
google_analytics_id : "" # A GA id that can be used to track book views.
46+
home_page_in_navbar : true # Whether to include your home page in the left Navigation Bar
47+
# baseurl : "" # The base URL where your book will be hosted. Used for creating image previews and social links. e.g.: https://mypage.com/mybook/
48+
# analytics:
49+
# comments:
50+
# hypothesis : false
51+
# utterances : false
52+
# announcement : "" # A banner announcement at the top of the site.
53+
54+
#######################################################################################
55+
# LaTeX and BibTex settings
56+
latex:
57+
latex_engine : pdflatex # one of 'pdflatex', 'xelatex' (recommended for unicode), 'luatex', 'platex', 'uplatex'
58+
use_jupyterbook_latex : true # use sphinx-jupyterbook-latex for pdf builds as default
59+
60+
bibtex_bibfiles:
61+
- CompMethods_references.bib
62+
####################################################
63+
# Launch button settings
64+
launch_buttons:
65+
notebook_interface : 'classic' # The interface interactive links will activate ["classic", "jupyterlab"]
66+
# binderhub_url : https://mybinder.org # The URL of the BinderHub (e.g., https://mybinder.org)
67+
# jupyterhub_url : "" # The URL of the JupyterHub (e.g., https://datahub.berkeley.edu)
68+
# thebelab : false # Add a thebelab button to pages (requires the repository to run on Binder)
69+
colab_url : "" # The URL of Google Colab (https://colab.research.google.com)
70+
71+
#######################################################################################
72+
# FiscalSim-US repository settings
73+
repository:
74+
url: https://github.com/OpenSourceEcon/CompMethods
75+
branch: main
76+
path_to_book: "docs/book"
77+
78+
#######################################################################################
79+
# Advanced and power-user settings
80+
sphinx:
81+
extra_extensions : ['sphinx.ext.autodoc', 'sphinx.ext.mathjax',
82+
'sphinx.ext.viewcode', 'sphinx.ext.napoleon',
83+
'alabaster'] # A list of extra extensions to load by Sphinx.
84+
config : # key-value pairs to directly over-ride the Sphinx configuration
85+
bibtex_reference_style: author_year
86+
mathjax_path : https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
87+
88+
#######################################################################################
89+
# Advanced Sphinx settings
90+
sphinx:
91+
extra_extensions: ['sphinx.ext.autodoc', 'sphinx.ext.mathjax',
92+
'sphinx.ext.viewcode', 'sphinx.ext.napoleon',
93+
'alabaster', 'sphinx_exercise'] # A list of extra extensions to load by Sphinx.
94+
config: # key-value pairs to directly over-ride the Sphinx configuration
95+
bibtex_reference_style: author_year
96+
mathjax_path: https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
97+
html_js_files:
98+
- https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js
99+
# html_theme: furo
100+
pygments_style: default
101+
extra_extensions:
102+
- "sphinx.ext.autodoc"
103+
- "sphinxarg.ext"
104+
- "sphinx.ext.viewcode"
105+
- "sphinx.ext.napoleon"
106+
- "sphinx.ext.mathjax"
107+
- "sphinx_exercise"

0 commit comments

Comments
 (0)