Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[UPDATE] enable execution by switching to use myst_nb #29

Merged
merged 5 commits into from Sep 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
@@ -1,4 +1,4 @@
name: Build Project [myst_parser]
name: Build Project [myst]
on: [push]
jobs:
tests:
Expand All @@ -23,7 +23,7 @@ jobs:
- name: Install Dependencies
shell: bash -l {0}
run: |
pip install sphinx-book-theme myst-parser
pip install sphinx-book-theme myst-nb
- name: Display Conda Environment Versions
shell: bash -l {0}
run: conda list
Expand Down
117 changes: 0 additions & 117 deletions conf.py
Expand Up @@ -39,7 +39,6 @@
'sphinxcontrib.bibtex',
'IPython.sphinxext.ipython_console_highlighting',
# Custom Sphinx Extensions
'sphinxcontrib.jupyter',
'myst_nb',
]

Expand Down Expand Up @@ -368,119 +367,3 @@

linkcheck_timeout = 30

# --------------------------------------------
# jupyter Sphinx Extension conversion settings
# --------------------------------------------

# Conversion Mode Settings
# If "all", convert codes and texts into notebook
# If "code", convert codes only
jupyter_conversion_mode = "all"

jupyter_write_metadata = False

# Location for _static folder
jupyter_static_file_path = ["source/_static", "_static"]

# Configure Jupyter Kernels
jupyter_kernels = {
"python3": {
"kernelspec": {
"display_name": "Python",
"language": "python3",
"name": "python3"
},
"file_extension": ".py",
},
}

# Configure jupyter headers
jupyter_headers = {
"python3": [
# nbformat.v4.new_code_cell("%autosave 0") #@mmcky please make this an option
],
"julia": [
],
}

# Filename for the file containing the welcome block
jupyter_welcome_block = ""

#Adjust links to target html (rather than ipynb)
jupyter_target_html = False

#path to download notebooks from
jupyter_download_nb_urlpath = None

#allow downloading of notebooks
jupyter_download_nb = False

#Use urlprefix images
jupyter_download_nb_image_urlpath = None

#Allow ipython as a language synonym for blocks to be ipython highlighted
jupyter_lang_synonyms = ["ipython", "ipython3"]

#Execute skip-test code blocks for rendering of website (this will need to be ignored in coverage testing)
jupyter_ignore_skip_test = True

#allow execution of notebooks
jupyter_execute_notebooks = False

# Location of template folder for coverage reports
jupyter_template_coverage_file_path = False

# generate html from IPYNB files
jupyter_generate_html = False

# html template specific to your website needs
jupyter_html_template = ""

# latex template specific to your website needs
jupyter_latex_template = ""

#make website
jupyter_make_site = False

#force markdown image inclusion
jupyter_images_markdown = True

#This is set true by default to pass html to the notebooks
jupyter_allow_html_only=True

## Theme specific variables
# jupyter_theme_path = 'theme/minimal' #Specified in Makefile
# jupyter_template_path = 'theme/minimal/templates' #Specified in Makefile

jupyter_nextprev_ignore = ['404', "search", "status", "troubleshooting"]

### pdf options
jupyter_pdf_logo = "_static/img/qe-menubar-logo.png"

jupyter_bib_file = "_static/quant-econ"

jupyter_pdf_author = "Thomas J. Sargent and John Stachurski"

# Exclude Document Patterns for PDF Construction
jupyter_pdf_excludepatterns = ["404", "index", "references"]

# Set urlpath for html links in documents
jupyter_pdf_urlpath = "https://python-programming.quantecon.org/"

# make book
jupyter_pdf_book = False

# book title
jupyter_pdf_book_title = "Python Programming for Economics and Finance"

# pdf book name
jupyter_pdf_book_name = "python_programming_for_economics_finance"

# pdf toc file
jupyter_pdf_book_index = "index_toc"

# tomyst Config

# Set Destination path
tomyst_static_file_path = ['source/rst/_static']
tomyst_parser = "myst_nb"