Skip to content

updates to README #64

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 1 commit into from
Oct 6, 2020
Merged

updates to README #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 8 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,21 @@

Migration to Myst (Source files for https://python-programming.quantecon.org)

Preview builds are available on Pull Requests
**WARNING:** These are **NOT** currently the source files for the current live site.

The build of the [master branch is available here](https://epic-agnesi-957267.netlify.app)
## GH-PAGES

**WARNING:** These are NOT the source files for the live site. Please do not edit for that purpose.
This repository is hosted on Github Pages:

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.
https://quantecon.github.io/lecture-python-programming.myst/

## Conversion

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 and adapted to build using [jupyter-book](https://github.com/executablebooks/jupyter-book)

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`:

```bash
make html
```

or for `LaTeX`:

```bash
make latexpdf
```

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