1
0
mirror of https://github.com/gsi-upm/senpy synced 2024-12-22 13:08:13 +00:00

Minor fix setup and docs

This commit is contained in:
J. Fernando Sánchez 2019-07-18 11:40:41 +02:00
parent 435d107677
commit 7ae493b3f3
3 changed files with 13 additions and 9 deletions

View File

@ -13,7 +13,10 @@
"* Annotating text with sentiment and emotion using interoperable services\n", "* Annotating text with sentiment and emotion using interoperable services\n",
"* Switching to different services (service interoperability)\n", "* Switching to different services (service interoperability)\n",
"* Getting results in different formats (Turtle, XML, text...)\n", "* Getting results in different formats (Turtle, XML, text...)\n",
"* Asking for specific emotion models (automatic model conversion)" "* Asking for specific emotion models (automatic model conversion)\n",
"\n",
"The tutorial is originally published as an interactive [jupyter notebook](https://jupyter.org/) (`ipynb` file) that you can download and run locally.\n",
"The on-line documentation contains a **static** version of the notebook."
] ]
}, },
{ {
@ -27,9 +30,10 @@
"cell_type": "markdown", "cell_type": "markdown",
"metadata": {}, "metadata": {},
"source": [ "source": [
"We will use the demo server at http://senpy.gsi.upm.es abd the requests library.\n", "We will use the demo server at http://senpy.gsi.upm.es and the requests library.\n",
"\n", "\n",
"We will use a variable for our endpoint so you can try these examples on other instances:" "We will use a variable for our endpoint.\n",
"To try these examples on other instances simply change the value of this variable and re-run the query:"
] ]
}, },
{ {

View File

@ -293,11 +293,10 @@ texinfo_documents = [
#texinfo_no_detailmenu = False #texinfo_no_detailmenu = False
nbsphinx_prolog = """ nbsphinx_prolog = """
.. note:: This page has been auto-generated from a Jupyter notebook using nbsphinx_. .. note:: This is an `auto-generated <https://nbsphinx.readthedocs.io>`_ static view of a Jupyter notebook.
The original source is available at: https://github.com/gsi-upm/senpy/tree/master/docs//{{ env.doc2path(env.docname, base=None) }} To run the code examples in your computer, you may download the original notebook from the repository: https://github.com/gsi-upm/senpy/tree/master/docs/{{ env.doc2path(env.docname, base=None) }}
.. _nbsphinx: https://nbsphinx.readthedocs.io/
---- ----
""" """

View File

@ -16,9 +16,10 @@ limitations under the License.
from setuptools import setup from setuptools import setup
from os import path from os import path
import io
try: try:
with open('senpy/VERSION') as f: with io.open('senpy/VERSION') as f:
__version__ = f.read().strip() __version__ = f.read().strip()
assert __version__ assert __version__
except IOError: # pragma: no cover except IOError: # pragma: no cover
@ -28,13 +29,13 @@ except IOError: # pragma: no cover
def parse_requirements(filename): def parse_requirements(filename):
""" load requirements from a pip requirements file """ """ load requirements from a pip requirements file """
with open(filename, 'r') as f: with io.open(filename, 'r') as f:
lineiter = list(line.strip() for line in f) lineiter = list(line.strip() for line in f)
return [line for line in lineiter if line and not line.startswith("#")] return [line for line in lineiter if line and not line.startswith("#")]
this_directory = path.abspath(path.dirname(__file__)) this_directory = path.abspath(path.dirname(__file__))
with open(path.join(this_directory, 'README.rst'), encoding='utf-8') as f: with io.open(path.join(this_directory, 'README.rst'), encoding='utf-8') as f:
long_description = f.read() long_description = f.read()