Skip to content

Commit

Permalink
Matt/docs fix (#58)
Browse files Browse the repository at this point in the history
* Fixed readme snippet references

* Fixd documentation for docs build
  • Loading branch information
MSeal authored Nov 1, 2022
1 parent 754ac13 commit 9e820d7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
To rebuild the site run:

```bash
PYTHONPATH=path/to/papermill-origami/papermill_origami mkdocs build
mkdocs build
```

To serve the docs run:

```bash
PYTHONPATH=path/to/papermill-origami/papermill_origami mkdocs serve
mkdocs serve
```

To verify a file has appropriate commenting to support mkdocs use:
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,19 @@

[Install](#installation) | [Getting Started](#getting-started) | [License](./LICENSE) | [Code of Conduct](./CODE_OF_CONDUCT.md) | [Contributing](./CONTRIBUTING.md)

# --8<-- [start:intro]
<!-- --8<-- [start:intro] -->
## Intro to Papermill-Origami

Papermill-Origami is the bridge library between the [Origami Noteable SDK](https://noteable-origami.readthedocs.io/en/latest/) and [Papermill](https://papermill.readthedocs.io/en/latest/). It build a papermill engine that can talk to Noteable APIs to run Notebooks.
# --8<-- [end:intro]
<!-- --8<-- [end:intro] -->

# --8<-- [start:requirements]
<!-- --8<-- [start:requirements] -->
## Requirements

Python 3.8+
# --8<-- [end:requirements]
<!-- --8<-- [end:requirements] -->

# --8<-- [start:install]
<!-- --8<-- [start:install] -->
## Installation

### Poetry
Expand All @@ -40,9 +40,9 @@ poetry add papermill-origami
```shell
pip install papermill-origami
```
# --8<-- [end:install]
<!-- --8<-- [end:install] -->

# --8<-- [start:start]
<!-- --8<-- [start:start] -->
## Getting Started

### API Token
Expand Down Expand Up @@ -116,7 +116,7 @@ async with NoteableClient(token, config=ClientConfig(domain=domain)) as client:
client=client,
)
```
# --8<-- [end:start]
<!-- --8<-- [end:start] -->

## Contributing

Expand Down

0 comments on commit 9e820d7

Please sign in to comment.