Skip to content

Commit

Permalink
updates to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mmcky committed Aug 2, 2019
1 parent e96b1c6 commit d16bd03
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,22 +45,27 @@ and follow the on-screen questions.
To build a collection of notebooks using `Jupinx`:

```
jupinx --notebooks --directory <PATH>
jupinx --notebooks <PROJECT-DIRECTORY>
```

You can also use short versions such as:

```
jupinx -n -d <PATH>
jupinx -n <PROJECT-DIRECTORY>
```

If you are at the root level of your project directory you can trigger a build
without specifying the directory location:
As a convenience, if you are at the root level of your project directory you can trigger a build without specifying the directory location:

```
jupinx --notebooks
```

or simply

```
jupinx -n
```

You can also see the options available using:

```
Expand Down

0 comments on commit d16bd03

Please sign in to comment.