Skip to content

update README #1

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.

Sign up for GitHub

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

Merged
mmcky merged 2 commits into from
Sep 7, 2020
Merged

update README #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b289ffe
update README
mmcky Sep 7, 2020
1c89b22
add gitignore
mmcky Sep 7, 2020
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_build/
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand All @@ -23,4 +27,6 @@ or for `LaTeX`:

```bash
make latexpdf
```
```

but with all the tools that `jupyter-book` uses.