Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
domvwt committed May 30, 2022
1 parent 7d4e336 commit a0e7404
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 6 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,16 @@ from popular analytics packages.
Main Features
-------------

- Create beautiful analytical reports using idiomatic Python
- Generate content from:
- [Markdown][Markdown]
- [Pandas DataFrames][Pandas]
- [Matplotlib][Matplotlib]
- [Bokeh][Bokeh]
- [Plotly][Plotly]
- Develop interactively with Jupyter Notebooks
- Share reports as a self-contained webpage or PDF
- Customise with CSS and Jinja
- Develop interactively with [Jupyter Notebooks][Jupyter]
- Share documents as a self-contained webpage or PDF
- Customise with [CSS][CSS] and [Jinja][Jinja]
- Responsive [Bootstrap][Bootstrap] layout

Basic Usage
Expand Down Expand Up @@ -73,6 +74,10 @@ pip install esparto
conda install esparto -c conda-forge
```

```bash
poetry add esparto
```

Dependencies
------------

Expand Down Expand Up @@ -120,10 +125,12 @@ Iris Report - [Webpage](https://domvwt.github.io/esparto/examples/iris-report.ht
[Conda]: https://anaconda.org/conda-forge/esparto
[Bootstrap]: https://getbootstrap.com/
[Jinja]: https://jinja.palletsprojects.com/
[CSS]: https://developer.mozilla.org/en-US/docs/Web/CSS
[Markdown]: https://www.markdownguide.org/
[Pandas]: https://pandas.pydata.org/
[Matplotlib]: https://matplotlib.org/
[Bokeh]: https://bokeh.org/
[Plotly]: https://plotly.com/
[Jupyter]: https://jupyter.org/
[GitHub]: https://github.com/domvwt/esparto
[Issues]: https://github.com/domvwt/esparto/issues
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Output Options
# Report Style

## CSS and Jinja

Expand Down Expand Up @@ -61,7 +61,7 @@ python -m esparto print_bootstrap_css > bootstrap.css
python -m esparto print_default_options > esparto-config.yaml
```

## More options
## More Options

For details on additional options please read the
[documentation for the Options module.](/03-api-reference/options/)
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ nav:
- Overview: 'index.md'
- User Guide:
- 'Quick Start': '02-user-guide/quick-start.md'
- 'Output Options': '02-user-guide/output-options.md'
- 'Report Style': '02-user-guide/report-style.md'
- 'Tutorial Notebooks': '02-user-guide/tutorial-notebooks.md'
- API Reference:
- 'Layout': '03-api-reference/layout.md'
Expand Down

0 comments on commit a0e7404

Please sign in to comment.