diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..c6a151b3 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +_build/ \ No newline at end of file diff --git a/README.md b/README.md index 7097a6b0..60086a26 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,19 @@ Migration to Myst (Source files for https://python-programming.quantecon.org) -**WARNING:** This is NOT the source files for the live site. Please do not edit for that purpose. +Preview builds are available on Pull Requests -These are files automatically converted from [sphinxcontrib-tomyst](https://github.com/mmcky/sphinxcontrib-tomyst) for the QuantEcon migration project. +**WARNING:** These are NOT the source files for the live site. Please do not edit for that purpose. + +These are files automatically converted from [lecture-python-programming](https://github.com/QuantEcon/lecture-python-programming) using [sphinxcontrib-tomyst](https://github.com/mmcky/sphinxcontrib-tomyst)for the QuantEcon migration project. This repo has been setup to identify issues with myst conversion process which will need: 1. fixing upstream in [sphinxcontrib-tomyst](https://github.com/mmcky/sphinxcontrib-tomyst) 2. Manual intervention in the transfer process +Please raise problems as Issues on this repository. + ## Building Files Currently files are built using `myst_parser` via `sphinx`: @@ -23,4 +27,6 @@ or for `LaTeX`: ```bash make latexpdf -``` \ No newline at end of file +``` + +but with all the tools that `jupyter-book` uses. \ No newline at end of file