balkian/senpy
1
0
Fork 0
mirror of https://github.com/gsi-upm/senpy synced 2024-11-22 00:02:28 +00:00
Code Issues Releases Wiki Activity

Moved to gsiupm

Browse Source 
* Updated sphinx docs to include schemas and version
* Added docker push to makefile
This commit is contained in:
J. Fernando Sánchez 2016-09-21 10:10:49 +02:00
parent fff38bf825
commit 7205a0e7b2
6 changed files with 21 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Makefile
View File

@ -1,4 +1,4 @@
PYVERSIONS=2.7 3.4
PYVERSIONS=3.4 2.7
NAME=senpy
REPO=gsiupm
VERSION=$(shell cat $(NAME)/VERSION)
@ -24,6 +24,15 @@ test-%: build-%
test_pip-%:
docker run --rm -ti python:$* pip -q install senpy ;
upload-%:
docker push '$(REPO)/$(NAME):$(VERSION)-python$(firstword $(PYVERSIONS))'
upload: test $(addprefix upload-,$(PYVERSIONS))
docker tag '$(REPO)/$(NAME):$(VERSION)-python$(firstword $(PYVERSIONS))' '$(REPO)/$(NAME):$(VERSION)'
docker tag '$(REPO)/$(NAME):$(VERSION)-python$(firstword $(PYVERSIONS))' '$(REPO)/$(NAME)'
docker push '$(REPO)/$(NAME):$(VERSION)'
docker push '$(REPO)/$(NAME)'
test_pip: $(addprefix test_pip-,$(PYVERSIONS))
.PHONY: test test-% build-% build test test_pip

4
README.rst
View File

@ -38,9 +38,9 @@ If you want to install senpy globally, use sudo instead of the ``--user`` flag.
Docker Image
************
Build the image or use the pre-built one: ``docker run -ti -p 5000:5000 balkian/senpy --host 0.0.0.0 --default-plugins``.
Build the image or use the pre-built one: ``docker run -ti -p 5000:5000 gsiupm/senpy --host 0.0.0.0 --default-plugins``.
To add custom plugins, add a volume and tell senpy where to find the plugins: ``docker run -ti -p 5000:5000 -v <PATH OF PLUGINS>:/plugins balkian/senpy --host 0.0.0.0 --default-plugins -f /plugins``
To add custom plugins, add a volume and tell senpy where to find the plugins: ``docker run -ti -p 5000:5000 -v <PATH OF PLUGINS>:/plugins gsiupm/senpy --host 0.0.0.0 --default-plugins -f /plugins``
Usage
-----

1
docs/_static/schemas vendored Symbolic link
View File

@ -0,0 +1 @@
../../senpy/schemas/

7
docs/conf.py
View File

@ -52,16 +52,17 @@ master_doc = 'index'
# General information about the project.
project = u'Senpy'
copyright = u'2015, J. Fernando Sánchez'
copyright = u'2016, J. Fernando Sánchez'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.4'
with open('../senpy/VERSION') as f:
version = f.read().strip()
# The full version, including alpha/beta/rc tags.
release = '0.4'
release = version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

4
docs/installation.rst
View File

@ -22,6 +22,6 @@ If you want to install senpy globally, use sudo instead of the ``--user`` flag.
Docker Image
************
Build the image or use the pre-built one: ``docker run -ti -p 5000:5000 balkian/senpy --host 0.0.0.0 --default-plugins``.
Build the image or use the pre-built one: ``docker run -ti -p 5000:5000 gsiupm/senpy --host 0.0.0.0 --default-plugins``.
To add custom plugins, add a volume and tell senpy where to find the plugins: ``docker run -ti -p 5000:5000 -v <PATH OF PLUGINS>:/plugins balkian/senpy --host 0.0.0.0 --default-plugins -f /plugins``
To add custom plugins, add a volume and tell senpy where to find the plugins: ``docker run -ti -p 5000:5000 -v <PATH OF PLUGINS>:/plugins gsiupm/senpy --host 0.0.0.0 --default-plugins -f /plugins``

2
docs/schema.rst
View File

@ -1,6 +1,6 @@
Schema Examples
===============
All the examples in this page use the schema defined in :ref:`schema`.
All the examples in this page use the :download:`the main schema <_static/schemas/definitions.json>`.
Simple NIF annotation
---------------------