Skip to content

Commit

Permalink
Move sphinx docs to seperate file
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjsewell committed Feb 27, 2020
1 parent 2201665 commit c0b1c90
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/using/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ MyST documents.

```{toctree}
install.md
sphinx.md
syntax.md
use_api.md
```
6 changes: 0 additions & 6 deletions docs/using/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,3 @@ pip install -e .[sphinx,code_style,testing,rtd]

This should install the myst fork of mistletoe, along with the Sphinx parser
that is included in the "extensions" configuration of this site.

## Using Myst Parser with Sphinx

Sphinx is a documentation generator for building a website or book from multiple source documents and assets. To get started with Sphinx, see their [Quickstart Guide](https://www.sphinx-doc.org/en/master/usage/quickstart.html).

To use the MyST parser in Sphinx, simply add: `extensions = ["myst_parser"]` to your `conf.py`.
7 changes: 7 additions & 0 deletions docs/using/sphinx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Using with the Sphinx Document Generator

Sphinx is a documentation generator for building a website or book from multiple source documents and assets. To get started with Sphinx, see their [Quickstart Guide](https://www.sphinx-doc.org/en/master/usage/quickstart.html).

To use the MyST parser in Sphinx, simply add: `extensions = ["myst_parser"]` to your `conf.py` and all documents with the `.md` extension will be parsed as MyST.

Naturally this site is generated with Sphinx and MyST!

0 comments on commit c0b1c90

Please sign in to comment.