Skip to content

Commit

Permalink
minor edits
Browse files Browse the repository at this point in the history
  • Loading branch information
jstac committed Aug 6, 2019
1 parent cfb4322 commit 2503d8f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 13 deletions.
5 changes: 2 additions & 3 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,8 @@ <h1 class="sr-only">Jupinx</h1>

<p class="header-tagline">Welcome to Jupinx, a build system for lectures.</p>

<p class="header-description">Jupinx is an open source tool built by <a href="https://quantecon.org/">QuantEcon</a> for building <a href="https://lectures.quantecon.org/">QuantEcon lectures</a>
from RST to a collection of <a href="http://jupyter.org">Jupyter Notebooks</a>. It is a collection of utilities for working with
<a href="http://www.sphinx-doc.org/en/master/">Sphinx</a> and <a href="http://jupyter.org">Jupyter Notebooks</a>.</p>
<p class="header-description">Jupinx is an open source tool for converting <a href="http://docutils.sourceforge.net/rst.html">ReStructuredText</a>
source files into a website via <a href="http://jupyter.org">Jupyter Notebooks</a>.</p>

</div>

Expand Down
11 changes: 1 addition & 10 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,7 @@ When starting your own projects a `jupinx-quickstart` is available that will gui
of a sphinx project that is setup to use the [sphinxcontrib-jupyter](https://github.com/QuantEcon/sphinxcontrib-jupyter)
extension.

Open a terminal and make a folder for your project. Then run:

```
jupinx-quickstart
```

and follow the on-screen questions.

> **_NOTE:_** You may also specify a target folder during the quickstart process.
> However that folder must already exist.
For more information, please see the [tutorial](tutorial.md)


### Usage
Expand Down
3 changes: 3 additions & 0 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ cd jupinx-project
jupinx-quickstart
```

> **_NOTE:_** You may also specify a target folder during the quickstart process, as long as that folder already exists.

The `quickstart-utility` will take you through a series of questions to assist with
this configuration:

Expand Down

0 comments on commit 2503d8f

Please sign in to comment.