Small tweaks in docs

2024-11-14 04:32:29 +00:00 · 2019-04-04 18:53:55 +02:00 · 2019-04-04 18:53:55 +02:00 · 45421f4613
commit 45421f4613
parent 7aa69e3d02
6 changed files with 35 additions and 31 deletions
--- a/.travis.yml
+++ b/.travis.yml
@ -6,10 +6,10 @@ services:
 language: python

 env:
-  - PYV=3.3
  - PYV=3.4
  - PYV=3.5
  - PYV=3.6
  - PYV=3.7
+#  - PYV=3.3 # Apt fails in this docker image
 # run nosetests - Tests
 script: make test-$PYV
--- a/docs/Quickstart-10minutes.ipynb
+++ b/docs/Quickstart-10minutes.ipynb
@ -83,7 +83,7 @@
  },
  {
   "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
   "metadata": {},
   "outputs": [
    {
@ -168,7 +168,7 @@
       "        <span class=\"p\">{</span>\n",
       "          <span class=\"nd\">&quot;@type&quot;</span><span class=\"p\">:</span> <span class=\"s2\">&quot;Sentiment&quot;</span><span class=\"p\">,</span>\n",
       "          <span class=\"nt\">&quot;marl:hasPolarity&quot;</span><span class=\"p\">:</span> <span class=\"s2\">&quot;marl:Positive&quot;</span><span class=\"p\">,</span>\n",
-       "          <span class=\"nt\">&quot;prov:wasGeneratedBy&quot;</span><span class=\"p\">:</span> <span class=\"s2\">&quot;prefix:Analysis_1554391718.7649393&quot;</span>\n",
+       "          <span class=\"nt\">&quot;prov:wasGeneratedBy&quot;</span><span class=\"p\">:</span> <span class=\"s2\">&quot;prefix:Analysis_1554396807.629645&quot;</span>\n",
       "        <span class=\"p\">}</span>\n",
       "      <span class=\"p\">],</span>\n",
       "      <span class=\"nt\">&quot;nif:isString&quot;</span><span class=\"p\">:</span> <span class=\"s2\">&quot;Senpy is awesome&quot;</span><span class=\"p\">,</span>\n",
@ -191,7 +191,7 @@
       "        \\PY{p}{\\PYZob{}}\n",
       "          \\PY{n+nd}{\\PYZdq{}@type\\PYZdq{}}\\PY{p}{:} \\PY{l+s+s2}{\\PYZdq{}Sentiment\\PYZdq{}}\\PY{p}{,}\n",
       "          \\PY{n+nt}{\\PYZdq{}marl:hasPolarity\\PYZdq{}}\\PY{p}{:} \\PY{l+s+s2}{\\PYZdq{}marl:Positive\\PYZdq{}}\\PY{p}{,}\n",
-       "          \\PY{n+nt}{\\PYZdq{}prov:wasGeneratedBy\\PYZdq{}}\\PY{p}{:} \\PY{l+s+s2}{\\PYZdq{}prefix:Analysis\\PYZus{}1554391718.7649393\\PYZdq{}}\n",
+       "          \\PY{n+nt}{\\PYZdq{}prov:wasGeneratedBy\\PYZdq{}}\\PY{p}{:} \\PY{l+s+s2}{\\PYZdq{}prefix:Analysis\\PYZus{}1554396807.629645\\PYZdq{}}\n",
       "        \\PY{p}{\\PYZcb{}}\n",
       "      \\PY{p}{]}\\PY{p}{,}\n",
       "      \\PY{n+nt}{\\PYZdq{}nif:isString\\PYZdq{}}\\PY{p}{:} \\PY{l+s+s2}{\\PYZdq{}Senpy is awesome\\PYZdq{}}\\PY{p}{,}\n",
@ -213,7 +213,7 @@
       "        {\n",
       "          \"@type\": \"Sentiment\",\n",
       "          \"marl:hasPolarity\": \"marl:Positive\",\n",
-       "          \"prov:wasGeneratedBy\": \"prefix:Analysis_1554391718.7649393\"\n",
+       "          \"prov:wasGeneratedBy\": \"prefix:Analysis_1554396807.629645\"\n",
       "        }\n",
       "      ],\n",
       "      \"nif:isString\": \"Senpy is awesome\",\n",
@ -223,7 +223,7 @@
       "}"
      ]
     },
-     "execution_count": 3,
+     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
--- a/docs/Quickstart-1minute.ipynb
+++ b/docs/Quickstart-1minute.ipynb
@ -6,8 +6,8 @@
   "source": [
    "# Senpy in 1 minute\n",
    "\n",
-    "This mini-tutorial is the first in the series of senpy tutorials. It only shows how to annotate with a service.\n",
-    "In this first tutorial, we will use the [demo server](http://senpy.gsi.upm.es), which runs some open source plugins for sentiment and emotion analysis."
+    "This mini-tutorial only shows how to annotate with a service.\n",
+    "We will use the [demo server](http://senpy.gsi.upm.es), which runs some open source plugins for sentiment and emotion analysis."
   ]
  },
  {
@ -57,7 +57,7 @@
   "cell_type": "markdown",
   "metadata": {},
   "source": [
-    "Congratulations, you've used your first senpy service!"
+    "**Congratulations**, you've used your first senpy service!"
   ]
  },
  {
--- a/docs/conf.py
+++ b/docs/conf.py
@ -83,6 +83,8 @@ language = None
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build', '**.ipynb_checkpoints']

+
+
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
 #default_role = None
--- a/docs/index.rst
+++ b/docs/index.rst
@ -1,16 +1,16 @@
 Welcome to Senpy's documentation!
 =================================
-.. image:: https://readthedocs.org/projects/senpy/badge/?version=latest
-   :target: http://senpy.readthedocs.io/en/latest/
-.. image:: https://badge.fury.io/py/senpy.svg
-   :target: https://badge.fury.io/py/senpy
-.. image:: https://lab.gsi.upm.es/senpy/senpy/badges/master/build.svg
-   :target: https://lab.gsi.upm.es/senpy/senpy/commits/master
-.. image:: https://lab.gsi.upm.es/senpy/senpy/badges/master/coverage.svg
-   :target: https://lab.gsi.upm.es/senpy/senpy/commits/master
-.. image:: https://img.shields.io/pypi/l/requests.svg
-   :target: https://lab.gsi.upm.es/senpy/senpy/

+.. image:: https://readthedocs.org/projects/senpy/badge/?version=latest
+  :target: http://senpy.readthedocs.io/en/latest/
+.. image:: https://badge.fury.io/py/senpy.svg
+  :target: https://badge.fury.io/py/senpy
+.. image:: https://lab.gsi.upm.es/senpy/senpy/badges/master/build.svg
+  :target: https://lab.gsi.upm.es/senpy/senpy/commits/master
+.. image:: https://lab.gsi.upm.es/senpy/senpy/badges/master/coverage.svg
+  :target: https://lab.gsi.upm.es/senpy/senpy/commits/master
+.. image:: https://img.shields.io/pypi/l/requests.svg
+  :target: https://lab.gsi.upm.es/senpy/senpy/


 Senpy is a framework for sentiment and emotion analysis services.
@ -20,14 +20,16 @@ If you interested in consuming Senpy services, read :doc:`Quickstart`.
 To get familiar with the concepts behind Senpy, and what it can offer for service developers, check out :doc:`development`.
 :doc:`apischema` contains information about the semantic models and vocabularies used by Senpy.

-.. toctree::
-   :caption: Learn more about senpy:
-   :maxdepth: 2

-   senpy
-   demo
-   Quickstart.ipynb
-   installation
-   apischema
-   advanced
-   publications
+.. toctree::
+  :caption: Learn more about senpy:
+  :maxdepth: 2
+
+  senpy
+  demo
+  Quickstart.ipynb
+  installation
+  apischema
+  advanced
+  publications
+
--- a/docs/senpy.rst
+++ b/docs/senpy.rst
@ -18,10 +18,10 @@ And higher level features can be built on top of these services, such as automat

 These benefits are not limited to new services.
 The community has developed wrappers for some proprietary and commercial services (such as sentiment140 and Meaning Cloud), so you can consult them as.
-Senpy comes with a :ref:`built-in client`.
+Senpy comes with a built-in client in the client package.


 To achieve this goal, Senpy uses a Linked Data principled approach, based on the NIF (NLP Interchange Format) specification, and open vocabularies such as Marl and Onyx.
 You can learn more about this in :doc:`vocabularies`.

-Check out :doc:`plugins` if you have developed an analysis algorithm (e.g. sentiment analysis) and you want to publish it as a service.
+Check out :doc:`development` if you have developed an analysis algorithm (e.g. sentiment analysis) and you want to publish it as a service.