Skip to content

Commit

Permalink
Update docs and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
domvwt committed Apr 7, 2021
1 parent 43e4c3d commit c509c9b
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 60 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/01-getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ my_page.save("esparto-quick.html")

The rendered HTML document:

<img src='/images/esparto-quickstart-screenshot.png' style='border: 1px dotted lightgrey; width: 80%; height: 80%'>
<img src='../esparto-quickstart-screenshot.png' style='border: 1px dotted lightgrey; width: 80%; height: 80%'>

<br>

Expand All @@ -53,7 +53,7 @@ html = my_page.save("esparto-quick-image.html")

Esparto determines that the string points to a valid image and loads the file:

<img src='/images/esparto-image-screenshot.png' height=70% style='border: 1px dotted lightgrey; width: 80%; height: 80%'>
<img src='../esparto-image-screenshot.png' height=70% style='border: 1px dotted lightgrey; width: 80%; height: 80%'>

<br>

Expand Down
2 changes: 1 addition & 1 deletion docs/04-about/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Release Notes
=============

0.1.0 (2021-04-04)
0.1.0 (2021-04-07)
------------------

- First public release.
Expand Down
22 changes: 11 additions & 11 deletions docs/examples/iris.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@
{
"data": {
"text/plain": [
"<esparto._content.Markdown at 0x7f986a73deb0>"
"<esparto._content.Markdown at 0x7f4c71281d60>"
]
},
"execution_count": 5,
Expand Down Expand Up @@ -272,7 +272,7 @@
{
"data": {
"text/plain": [
"<esparto._content.Markdown at 0x7f986a75b0a0>"
"<esparto._content.Markdown at 0x7f4bef3f91c0>"
]
},
"execution_count": 6,
Expand Down Expand Up @@ -372,7 +372,7 @@
{
"data": {
"text/plain": [
"<esparto._content.Image at 0x7f986a7618b0>"
"<esparto._content.Image at 0x7f4bef401460>"
]
},
"execution_count": 8,
Expand Down Expand Up @@ -877,7 +877,7 @@
{
"data": {
"text/plain": [
"<esparto._content.DataFramePd at 0x7f98ce0467c0>"
"<esparto._content.DataFramePd at 0x7f4bef401c10>"
]
},
"execution_count": 13,
Expand Down Expand Up @@ -1252,7 +1252,7 @@
{
"data": {
"text/plain": [
"<esparto._content.FigureMpl at 0x7f98cdba2370>"
"<esparto._content.FigureMpl at 0x7f4c58cf2850>"
]
},
"execution_count": 20,
Expand Down Expand Up @@ -1867,7 +1867,7 @@
},
{
"cell_type": "code",
"execution_count": 28,
"execution_count": null,
"metadata": {
"colab": {
"base_uri": "https://localhost:8080/"
Expand All @@ -1882,17 +1882,17 @@
"if 'google.colab' in str(get_ipython()):\n",
" from google.colab.output import eval_js\n",
" page_link = f\"{eval_js('google.colab.kernel.proxyPort(8000)')}{page_name}\"\n",
" print(msg, page_link)\n",
" es.Markdown(f\"[{page_link}]({page_link})\").display()\n",
" print(\"(Interrupt the kernel to stop the http server process when you're done)\")\n",
" !python -m http.server 8000 > /dev/null 2>&1\n",
"elif os.environ.get(\"BINDER_SERVICE_HOST\"):\n",
" import socket\n",
" hash_id = socket.gethostname()[-8:]\n",
" page_link = f\"https://hub-binder.mybinder.ovh/user/domvwt-esparto-{hash_id}/view/docs/examples/iris-report.html\"\n",
" print(msg, page_link)\n",
" es.Markdown(f\"[{page_link}]({page_link})\").display()\n",
"else:\n",
" page_link = \"./iris-report-html\"\n",
" print(msg, pagelink)"
" page_link = \"./iris-report.html\"\n",
" es.Markdown(f\"[{page_link}]({page_link})\").display()"
]
},
{
Expand Down Expand Up @@ -1931,4 +1931,4 @@
},
"nbformat": 4,
"nbformat_minor": 1
}
}
Binary file removed docs/images/esparto-image-screenshot.png
Binary file not shown.
Binary file removed docs/images/esparto-quickstart-screenshot.png
Binary file not shown.
45 changes: 0 additions & 45 deletions esparto-doc.html

This file was deleted.

2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ theme:
features:
- 'navigation.tabs'

repo_url: 'https://github.com/domvwt/esparto'
repo_url: 'https://github.com/domvwt/esparto/'

markdown_extensions:
- admonition
Expand Down

0 comments on commit c509c9b

Please sign in to comment.