Skip to content

Commit

Permalink
fix(readme): Update schema URLs (#295)
Browse files Browse the repository at this point in the history
  • Loading branch information
tymokvo authored Mar 11, 2021
1 parent ebb3017 commit e963393
Showing 1 changed file with 42 additions and 27 deletions.
69 changes: 42 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,64 +15,79 @@ You can find more workflow samples in
[honeybee-radiance-workflow](https://github.com/ladybug-tools/honeybee-radiance-workflow)
repository.


## Installation

```
> pip install queenbee
```

or if you want to use the CLI

```
> pip install queenbee[cli]
```


## Documentation

You can access the full docs for this package and its CLI [here](https://ladybug.tools/queenbee).
You can access the full docs for this package and its CLI
[here](https://pollination.github.io/queenbee/).

You can also access the [Schema
Documentation](https://pollination.github.io/queenbee/schemas/index.html) and
OpenAPI documentation for:

| Object | Redoc | OpenAPI JSON |
| ------ | --------------------- | ------------------- |
| Plugin | [redoc][plugin-redoc] | [json][plugin-json] |
| Recipe | [redoc][recipe-redoc] | [json][recipe-json] |
| Job | [redoc][job-redoc] | [json][job-json] |

You can also access the [Schema Documentation](https://ladybug.tools/queenbee/redoc.html) and [raw OpenAPI definitions](https://ladybug.tools/queenbee/openapi.json).
[plugin-json]: https://pollination.github.io/queenbee/_static/schemas/plugin-openapi.json
[plugin-redoc]: https://pollination.github.io/queenbee/_static/redoc-plugin.html#tag/plugin_model
[recipe-json]: https://pollination.github.io/queenbee/_static/schemas/recipe-openapi.json
[recipe-redoc]: https://pollination.github.io/queenbee/_static/redoc-recipe.html#tag/recipe_model
[job-json]: https://pollination.github.io/queenbee/_static/schemas/job-openapi.json
[job-redoc]: https://pollination.github.io/queenbee/_static/redoc-job.html#tag/job_model

## Local Development

1. Clone this repo locally

```console
git clone [email protected]:ladybug-tools/queenbee
```
```console
git clone [email protected]:ladybug-tools/queenbee
```

or
or

```console
git clone https://github.com/ladybug-tools/queenbee
```
```console
git clone https://github.com/ladybug-tools/queenbee
```

2. Install dependencies:

```console
cd queenbee
pip install -r dev-requirements.txt
pip install -r requirements.txt
```
```console
cd queenbee
pip install -r dev-requirements.txt
pip install -r requirements.txt
```

3. Run Tests:

```console
python -m pytest tests/
```
```console
python -m pytest tests/
```

4. Generate Documentation:

```python
sphinx-apidoc -f -e -d 4 -o ./docs/modules ./queenbee
sphinx-build -b html ./docs ./docs/_build
```
```python
sphinx-apidoc -f -e -d 4 -o ./docs/modules ./queenbee
sphinx-build -b html ./docs ./docs/_build
```

5. Preview Documentation:

```console
python -m http.server --directory ./docs/_build/
```
```console
python -m http.server --directory ./docs/_build/
```

Now you can see the documentation preview at http://localhost:8000
Now you can see the documentation preview at http://localhost:8000

0 comments on commit e963393

Please sign in to comment.