diff --git a/README.md b/README.md index 5ed10b6..0c0eaf2 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,12 @@ esparto [![image](https://img.shields.io/pypi/v/esparto.svg)](https://pypi.python.org/pypi/esparto) [![image](https://img.shields.io/travis/domvwt/esparto.svg)](https://travis-ci.org/domvwt/esparto) [![codecov](https://codecov.io/gh/domvwt/esparto/branch/main/graph/badge.svg?token=35J8NZCUYC)](https://codecov.io/gh/domvwt/esparto) -[![Documentation Status](https://readthedocs.org/projects/esparto/badge/?version=latest)](https://esparto.readthedocs.io/en/latest/?badge=latest) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=domvwt_esparto&metric=alert_status)](https://sonarcloud.io/dashboard?id=domvwt_esparto) -A simple toolkit for creating accessible and shareable HTML documents. + +A simple toolkit for creating accessible and shareable HTML documents. + +Full documentation available at [domvwt.github.io/esparto/](https://domvwt.github.io/esparto/). ### Features * Lightweight API diff --git a/docs/01-getting-started/esparto-image-screenshot.png b/docs/01-getting-started/esparto-image-screenshot.png new file mode 100644 index 0000000..ef1453e Binary files /dev/null and b/docs/01-getting-started/esparto-image-screenshot.png differ diff --git a/docs/01-getting-started/esparto-quickstart-screenshot.png b/docs/01-getting-started/esparto-quickstart-screenshot.png new file mode 100644 index 0000000..6b38d36 Binary files /dev/null and b/docs/01-getting-started/esparto-quickstart-screenshot.png differ diff --git a/docs/01-getting-started/quickstart.md b/docs/01-getting-started/quickstart.md index 7bf8f51..3bd73e8 100644 --- a/docs/01-getting-started/quickstart.md +++ b/docs/01-getting-started/quickstart.md @@ -29,7 +29,7 @@ my_page.save("esparto-quick.html") The rendered HTML document: - +
@@ -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: - +
diff --git a/docs/04-about/release-notes.md b/docs/04-about/release-notes.md index d4188e1..09cbaea 100644 --- a/docs/04-about/release-notes.md +++ b/docs/04-about/release-notes.md @@ -1,7 +1,7 @@ Release Notes ============= -0.1.0 (2021-04-04) +0.1.0 (2021-04-07) ------------------ - First public release. diff --git a/docs/examples/iris.ipynb b/docs/examples/iris.ipynb index be8a20b..7d3e9e4 100644 --- a/docs/examples/iris.ipynb +++ b/docs/examples/iris.ipynb @@ -30,7 +30,11 @@ }, "outputs": [], "source": [ - "!pip install -Uqq esparto pandas matplotlib seaborn" + "# Environment setup\n", + "import os\n", + "!pip install -Uqq esparto\n", + "if os.environ.get(\"BINDER_SERVICE_HOST\"):\n", + " !pip install -Uqq pandas matplotlib seaborn" ] }, { @@ -41,9 +45,6 @@ }, "outputs": [], "source": [ - "from pathlib import Path\n", - "from subprocess import run\n", - "\n", "import esparto as es\n", "import pandas as pd\n", "import matplotlib.pyplot as plt\n", @@ -56,7 +57,7 @@ "id": "oOOwzOnkJcPI" }, "source": [ - "Before we start let's instatiate a Page object; we're not going to use this immediately but we'll need it later!" + "Before we start let's instantiate a Page object; we're not going to use this immediately but we'll need it later!" ] }, { @@ -195,7 +196,7 @@ { "data": { "text/plain": [ - "" + "" ] }, "execution_count": 5, @@ -271,7 +272,7 @@ { "data": { "text/plain": [ - "" + "" ] }, "execution_count": 6, @@ -371,7 +372,7 @@ { "data": { "text/plain": [ - "" + "" ] }, "execution_count": 8, @@ -394,7 +395,7 @@ "Now that we have some content ready for our introduction section, we can define the structure and check that it renders nicely.\n", "\n", "\n", - "See that the first row contains our intro text and iris virginica picture. The licenses and attribution have been added to a second row beneath these." + "Notice that the first row contains our intro text and iris virginica picture. The licenses and attribution have been added to a second row beneath these." ] }, { @@ -517,7 +518,7 @@ "id": "TRaAmkG1JcPT" }, "source": [ - "We have given a title to the section that helps identify it when looking at the document structure." + "Adding a title helps identify the item when looking at the document structure." ] }, { @@ -876,7 +877,7 @@ { "data": { "text/plain": [ - "" + "" ] }, "execution_count": 13, @@ -1251,7 +1252,7 @@ { "data": { "text/plain": [ - "" + "" ] }, "execution_count": 20, @@ -1861,13 +1862,12 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "import os\n", "Click the link below to view the page." ] }, { "cell_type": "code", - "execution_count": 28, + "execution_count": null, "metadata": { "colab": { "base_uri": "https://localhost:8080/" @@ -1877,22 +1877,22 @@ }, "outputs": [], "source": [ + "# Ignore this!\n", "msg = \"Page link:\"\n", "if 'google.colab' in str(get_ipython()):\n", " from google.colab.output import eval_js\n", - " from IPython.display import display, Markdown\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[\"BINDER_SERVICE_HOST\"]:\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()" ] }, { @@ -1931,4 +1931,4 @@ }, "nbformat": 4, "nbformat_minor": 1 -} \ No newline at end of file +} diff --git a/docs/images/esparto-image-screenshot.png b/docs/images/esparto-image-screenshot.png deleted file mode 100644 index a215978..0000000 Binary files a/docs/images/esparto-image-screenshot.png and /dev/null differ diff --git a/docs/images/esparto-quickstart-screenshot.png b/docs/images/esparto-quickstart-screenshot.png deleted file mode 100644 index b1fe339..0000000 Binary files a/docs/images/esparto-quickstart-screenshot.png and /dev/null differ diff --git a/esparto-doc.html b/esparto-doc.html deleted file mode 100644 index 9b9e2db..0000000 --- a/esparto-doc.html +++ /dev/null @@ -1,45 +0,0 @@ - - - - - esparto - - - - - - - - - - - -
-
-
-
-
-

- this - - is - - markdown - - content - -

-
-
-
-
-
- - - \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 8c41434..cd7292c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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