Merge pull request #32 from garciparedes/master

Issue 31

.github/ISSUE_TEMPLATE/version_release.md

@@ -6,6 +6,8 @@ labels: ''
 assignees: ''
 
 ---
+**Reference related Issues**
+Include a list of related issues.
 
 **Set a release date**
 A date and time specifying the release of the new version.

.readthedocs.yml

@@ -0,0 +1,13 @@
+version: 2
+formats: all
+python:
+   version: 3.7
+   install:
+      - method: pip
+        path: .
+        extra_requirements:
+            - docs
+   system_packages: false
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py

.travis.yml

@@ -5,8 +5,8 @@ python:
 cache: pip
 install:
   - 'pip install pipenv'
-  - 'pipenv sync --dev'
+  - 'pipenv sync'
 script:
-  - 'coverage run --source=jinete --module unittest discover tests'
+  - 'pipenv run coverage run --source=jinete --module unittest discover tests'
 after_success:
-  - 'codecov'
+  - 'pipenv run codecov'

Pipfile

@@ -4,12 +4,9 @@ url = "https://pypi.org/simple"
 verify_ssl = true
 
 [dev-packages]
-coverage = "*"
-coloredlogs = "*"
-codecov = "*"
 
 [packages]
-jinete = {editable = true,path = "."}
+jinete = {editable = true,extras = ["all"],path = "."}
 
 [requires]
 python_version = "3.7"

README.md

@@ -67,7 +67,7 @@ result = dispatcher.run()
 ```
 
 ## Documentation
-You can find the documentation at: https://jinete.readthedocs.io/
+You can find the documentation at: https://jinete.readthedocs.io
 
 
 ## Development

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/api_reference/api_reference.rst

@@ -0,0 +1,7 @@
+API reference
+=============
+
+.. toctree::
+   :glob:
+
+   jinete