Skip to content

Setup for Conversion to Myst using sphinx-tomyst #73

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

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/cache.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ jobs:
auto-update-conda: true
auto-activate-base: true
miniconda-version: 'latest'
python-version: 3.7
python-version: 3.8
environment-file: environment.yml
activate-environment: qe-lectures
- name: Checkout QuantEcon theme
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
auto-update-conda: true
auto-activate-base: true
miniconda-version: 'latest'
python-version: 3.7
python-version: 3.8
environment-file: environment.yml
activate-environment: qe-lectures
- name: Get Changed Files
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
auto-update-conda: true
auto-activate-base: true
miniconda-version: 'latest'
python-version: 3.7
python-version: 3.8
environment-file: environment.yml
activate-environment: qe-lectures
- name: Run Execution Tests
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-s3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
auto-update-conda: true
auto-activate-base: true
miniconda-version: 'latest'
python-version: 3.7
python-version: 3.8
environment-file: environment.yml
activate-environment: qe-lectures
- name: Checkout QuantEcon theme
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
auto-update-conda: true
auto-activate-base: true
miniconda-version: 'latest'
python-version: 3.7
python-version: 3.8
environment-file: environment.yml
activate-environment: qe-lectures
- name: Get Changed Files
Expand Down
17 changes: 15 additions & 2 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
'IPython.sphinxext.ipython_console_highlighting',
# Custom Sphinx Extensions
'sphinxcontrib.jupyter',
'sphinx_tomyst',
]

# Retired Extensions but may be useful in Future
Expand Down Expand Up @@ -131,15 +132,15 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'qe-lectures'
html_theme = 'sphinx_book_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['_themes']
# html_theme_path = ['_themes']

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
Expand Down Expand Up @@ -367,6 +368,8 @@

linkcheck_timeout = 30

# {{ tomyst-remove-start }}

# --------------------------------------------
# jupyter Sphinx Extension conversion settings
# --------------------------------------------
Expand Down Expand Up @@ -477,3 +480,13 @@

# 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"
tomyst_conf_removeblocks = True
tomyst_conf_dropcontaining = ["sphinxcontrib.jupyter"]

# {{ tomyst-remove-finish }}
7 changes: 4 additions & 3 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@ name: qe-lectures
channels:
- default
dependencies:
- python=3.7
- anaconda=2020.02
- python=3.8
- anaconda=2020.07
- pip
- pip:
- interpolation
- sphinxcontrib-jupyter
- sphinxcontrib-bibtex
- joblib
- joblib
- git+https://github.com/executablebooks/sphinx-tomyst