From 39d7161d2f3f819ff2740b150609e46ebb977443 Mon Sep 17 00:00:00 2001 From: Inkinen Juho M M Date: Tue, 14 May 2019 15:47:31 +0300 Subject: [PATCH 01/17] Include Sphinx in pipenv dev-packages --- Pipfile | 1 + 1 file changed, 1 insertion(+) diff --git a/Pipfile b/Pipfile index 52c3c66f0..79d1a4c93 100644 --- a/Pipfile +++ b/Pipfile @@ -11,6 +11,7 @@ pytest-flask = "*" "pytest-pep8" = "*" swagger-tester = "*" bumpversion = "*" +sphinx = "*" [packages] "e1839a8" = {editable = true, path = "."} From 97cc5bc8f4afd97c3270548d2dc76a66a4ee7f28 Mon Sep 17 00:00:00 2001 From: Inkinen Juho M M Date: Tue, 14 May 2019 17:04:32 +0300 Subject: [PATCH 02/17] Add initial infra for Sphinx documentation --- docs/Makefile | 19 ++++++++++++++++++ docs/conf.py | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 20 +++++++++++++++++++ docs/make.bat | 35 +++++++++++++++++++++++++++++++++ 4 files changed, 127 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..298ea9e21 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = . +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) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..94823f0f0 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,53 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('..')) + + +# -- Project information ----------------------------------------------------- + +project = 'annif' +copyright = '2017, University Of Helsinki (The National Library Of Finland)' +author = 'Osma Suominen' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc' +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..5db62ede5 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. annif documentation master file, created by + sphinx-quickstart on Tue May 14 14:24:19 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to annif's documentation! +================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 000000000..27f573b87 --- /dev/null +++ b/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=. +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% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd From 25ca5b1cb8dab0450ebdd2468852af53c4e3e213 Mon Sep 17 00:00:00 2001 From: Inkinen Juho M M Date: Tue, 14 May 2019 17:05:31 +0300 Subject: [PATCH 03/17] Include docs directory in autopep runs --- autopep8.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/autopep8.sh b/autopep8.sh index 8b00e1a80..eef99e49b 100755 --- a/autopep8.sh +++ b/autopep8.sh @@ -2,9 +2,9 @@ if [ "$1" = "-i" ]; then echo "Running autopep8 in in-place mode." - exec autopep8 -i -j0 -a -a -r annif tests *.py + exec autopep8 -i -j0 -a -a -r annif tests docs *.py else echo "Running autopep8 in diff mode. Use -i for in-place mode." echo "" - exec autopep8 -d -a -a -r annif tests *.py + exec autopep8 -d -a -a -r annif tests docs *.py fi From 736446ffbda495a3357236b0ca65afe0bb5ed8b2 Mon Sep 17 00:00:00 2001 From: Inkinen Juho M M Date: Wed, 15 May 2019 11:09:24 +0300 Subject: [PATCH 04/17] Git-ignore Sphinx build html documentation --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index b00d2a3ec..c65a12729 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,7 @@ __pycache__ .pytest_cache *.pyc data +docs/_build/ Pipfile.lock projects.cfg venv/ From 0abb9491b9dd6d30d5e5c5d094013296a03065a3 Mon Sep 17 00:00:00 2001 From: Inkinen Juho M M Date: Wed, 15 May 2019 12:01:09 +0300 Subject: [PATCH 05/17] Use ReadTheDocs theme for Sphinx --- Pipfile | 1 + docs/conf.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/Pipfile b/Pipfile index 79d1a4c93..4976bec4e 100644 --- a/Pipfile +++ b/Pipfile @@ -24,5 +24,6 @@ nltk = "*" gensim = "*" sklearn = "*" rdflib = "*" +sphinx-rtd-theme = "*" [requires] diff --git a/docs/conf.py b/docs/conf.py index 94823f0f0..172a29efa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -45,7 +45,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 483ff311c7e78c49c0c90f8b4be91f3c2604970b Mon Sep 17 00:00:00 2001 From: Inkinen Juho M M Date: Wed, 15 May 2019 13:44:25 +0300 Subject: [PATCH 06/17] Get version number from GitHub tag --- docs/conf.py | 7 +++++++ docs/index.rst | 2 ++ 2 files changed, 9 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 172a29efa..a72b70cd7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,6 +11,7 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. # import os +import re import sys sys.path.insert(0, os.path.abspath('..')) @@ -21,6 +22,12 @@ copyright = '2017, University Of Helsinki (The National Library Of Finland)' author = 'Osma Suominen' +# Get version number from GitHub tag +# The full version, including alpha/beta/rc tags. +release = re.sub('^v', '', os.popen('git describe --tags').read().strip()) +# The short X.Y version. +version = release + # -- General configuration --------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 5db62ede5..fe4ca0ac5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,6 +6,8 @@ Welcome to annif's documentation! ================================= +You are reading documentation for version |version|. + .. toctree:: :maxdepth: 2 :caption: Contents: From f68aa38dd5126c548012113fb925b19642802e8c Mon Sep 17 00:00:00 2001 From: Inkinen Juho M M Date: Wed, 15 May 2019 16:09:35 +0300 Subject: [PATCH 07/17] Initial non-autogenerated content --- docs/index.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index fe4ca0ac5..164018826 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,15 +3,19 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to annif's documentation! +Welcome to Annif's API documentation! ================================= +See `installation instructions `_ and `Wiki pages `_ in GitHub, and also http://annif.org/. + You are reading documentation for version |version|. + .. toctree:: - :maxdepth: 2 - :caption: Contents: + :maxdepth: 3 + :caption: Annif API Reference: + source/annif Indices and tables From 55740bd36fa2c2e7d85d98b16f6618f1daf0b2eb Mon Sep 17 00:00:00 2001 From: Inkinen Juho M M Date: Wed, 15 May 2019 16:41:14 +0300 Subject: [PATCH 08/17] Use version number without tailing hash in the GitHub tag --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index a72b70cd7..2cee8c359 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,7 +24,7 @@ # Get version number from GitHub tag # The full version, including alpha/beta/rc tags. -release = re.sub('^v', '', os.popen('git describe --tags').read().strip()) +release = re.sub('^v', '', os.popen('git describe --tags --abbrev=0').read().strip()) # The short X.Y version. version = release From 7b28c93fc462ba2b9c17f214fe2b6614ad75deb4 Mon Sep 17 00:00:00 2001 From: Juho Inkinen Date: Fri, 31 May 2019 13:20:12 +0300 Subject: [PATCH 09/17] Move readthedocs theme under dev packages --- Pipfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Pipfile b/Pipfile index 4976bec4e..1d2b2f5b1 100644 --- a/Pipfile +++ b/Pipfile @@ -12,6 +12,7 @@ pytest-flask = "*" swagger-tester = "*" bumpversion = "*" sphinx = "*" +sphinx-rtd-theme = "*" [packages] "e1839a8" = {editable = true, path = "."} @@ -24,6 +25,5 @@ nltk = "*" gensim = "*" sklearn = "*" rdflib = "*" -sphinx-rtd-theme = "*" [requires] From 749a2ccd9ebf2eb942e68b4bab03882629e7d84d Mon Sep 17 00:00:00 2001 From: Juho Inkinen Date: Fri, 31 May 2019 13:20:45 +0300 Subject: [PATCH 10/17] Fix too short title underline --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 164018826..1310386df 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,7 +4,7 @@ contain the root `toctree` directive. Welcome to Annif's API documentation! -================================= +===================================== See `installation instructions `_ and `Wiki pages `_ in GitHub, and also http://annif.org/. From 649d587e77f6818d3c473a7f851fa9830a9cbfe6 Mon Sep 17 00:00:00 2001 From: Juho Inkinen Date: Fri, 31 May 2019 13:40:33 +0300 Subject: [PATCH 11/17] PEP8-fix too long line --- docs/conf.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 2cee8c359..88e500c02 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,7 +24,11 @@ # Get version number from GitHub tag # The full version, including alpha/beta/rc tags. -release = re.sub('^v', '', os.popen('git describe --tags --abbrev=0').read().strip()) +release = re.sub( + '^v', + '', + os.popen('git describe --tags --abbrev=0').read().strip() +) # The short X.Y version. version = release From a25027e535b4033b223dee010840c7edb651458d Mon Sep 17 00:00:00 2001 From: Juho Inkinen Date: Fri, 31 May 2019 14:07:25 +0300 Subject: [PATCH 12/17] Include source dir containing .rst files for packages --- docs/source/annif.analyzer.rst | 43 ++++++++++++++ docs/source/annif.backend.rst | 83 ++++++++++++++++++++++++++ docs/source/annif.corpus.rst | 60 +++++++++++++++++++ docs/source/annif.rst | 105 +++++++++++++++++++++++++++++++++ docs/source/modules.rst | 7 +++ 5 files changed, 298 insertions(+) create mode 100644 docs/source/annif.analyzer.rst create mode 100644 docs/source/annif.backend.rst create mode 100644 docs/source/annif.corpus.rst create mode 100644 docs/source/annif.rst create mode 100644 docs/source/modules.rst diff --git a/docs/source/annif.analyzer.rst b/docs/source/annif.analyzer.rst new file mode 100644 index 000000000..990b461b5 --- /dev/null +++ b/docs/source/annif.analyzer.rst @@ -0,0 +1,43 @@ +annif.analyzer package +====================== + +annif.analyzer.analyzer module +------------------------------ + +.. automodule:: annif.analyzer.analyzer + :members: + :undoc-members: + :show-inheritance: + +annif.analyzer.simple module +---------------------------- + +.. automodule:: annif.analyzer.simple + :members: + :undoc-members: + :show-inheritance: + +annif.analyzer.snowball module +------------------------------ + +.. automodule:: annif.analyzer.snowball + :members: + :undoc-members: + :show-inheritance: + +annif.analyzer.voikko module +---------------------------- + +.. automodule:: annif.analyzer.voikko + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: annif.analyzer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/annif.backend.rst b/docs/source/annif.backend.rst new file mode 100644 index 000000000..2b9cef414 --- /dev/null +++ b/docs/source/annif.backend.rst @@ -0,0 +1,83 @@ +annif.backend package +===================== + +annif.backend.backend module +---------------------------- + +.. automodule:: annif.backend.backend + :members: + :undoc-members: + :show-inheritance: + +annif.backend.dummy module +-------------------------- + +.. automodule:: annif.backend.dummy + :members: + :undoc-members: + :show-inheritance: + +annif.backend.ensemble module +----------------------------- + +.. automodule:: annif.backend.ensemble + :members: + :undoc-members: + :show-inheritance: + +annif.backend.fasttext module +----------------------------- + +.. automodule:: annif.backend.fasttext + :members: + :undoc-members: + :show-inheritance: + +annif.backend.http module +------------------------- + +.. automodule:: annif.backend.http + :members: + :undoc-members: + :show-inheritance: + +annif.backend.mixins module +--------------------------- + +.. automodule:: annif.backend.mixins + :members: + :undoc-members: + :show-inheritance: + +annif.backend.pav module +------------------------ + +.. automodule:: annif.backend.pav + :members: + :undoc-members: + :show-inheritance: + +annif.backend.tfidf module +-------------------------- + +.. automodule:: annif.backend.tfidf + :members: + :undoc-members: + :show-inheritance: + +annif.backend.vw\_multi module +------------------------------ + +.. automodule:: annif.backend.vw_multi + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: annif.backend + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/annif.corpus.rst b/docs/source/annif.corpus.rst new file mode 100644 index 000000000..95596d11a --- /dev/null +++ b/docs/source/annif.corpus.rst @@ -0,0 +1,60 @@ +annif.corpus package +==================== + + +annif.corpus.combine module +--------------------------- + +.. automodule:: annif.corpus.combine + :members: + :undoc-members: + :show-inheritance: + +annif.corpus.convert module +--------------------------- + +.. automodule:: annif.corpus.convert + :members: + :undoc-members: + :show-inheritance: + +annif.corpus.document module +---------------------------- + +.. automodule:: annif.corpus.document + :members: + :undoc-members: + :show-inheritance: + +annif.corpus.skos module +------------------------ + +.. automodule:: annif.corpus.skos + :members: + :undoc-members: + :show-inheritance: + +annif.corpus.subject module +--------------------------- + +.. automodule:: annif.corpus.subject + :members: + :undoc-members: + :show-inheritance: + +annif.corpus.types module +------------------------- + +.. automodule:: annif.corpus.types + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: annif.corpus + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/annif.rst b/docs/source/annif.rst new file mode 100644 index 000000000..a616b47d6 --- /dev/null +++ b/docs/source/annif.rst @@ -0,0 +1,105 @@ +annif package +============= + +.. toctree:: + + annif.analyzer + annif.backend + annif.corpus + +annif.cli module +---------------- + +.. automodule:: annif.cli + :members: + :undoc-members: + :show-inheritance: + +annif.datadir module +-------------------- + +.. automodule:: annif.datadir + :members: + :undoc-members: + :show-inheritance: + +annif.default\_config module +---------------------------- + +.. automodule:: annif.default_config + :members: + :undoc-members: + :show-inheritance: + +annif.eval module +----------------- + +.. automodule:: annif.eval + :members: + :undoc-members: + :show-inheritance: + +annif.exception module +---------------------- + +.. automodule:: annif.exception + :members: + :undoc-members: + :show-inheritance: + +annif.project module +-------------------- + +.. automodule:: annif.project + :members: + :undoc-members: + :show-inheritance: + +annif.rest module +----------------- + +.. automodule:: annif.rest + :members: + :undoc-members: + :show-inheritance: + +annif.suggestion module +----------------------- + +.. automodule:: annif.suggestion + :members: + :undoc-members: + :show-inheritance: + +annif.util module +----------------- + +.. automodule:: annif.util + :members: + :undoc-members: + :show-inheritance: + +annif.views module +------------------ + +.. automodule:: annif.views + :members: + :undoc-members: + :show-inheritance: + +annif.vocab module +------------------ + +.. automodule:: annif.vocab + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: annif + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 000000000..d33c6f1cc --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +annif +===== + +.. toctree:: + :maxdepth: 4 + + annif From b978b4aeddb238ac0ed7dd1093a2f253679155a1 Mon Sep 17 00:00:00 2001 From: Juho Inkinen Date: Fri, 31 May 2019 14:21:20 +0300 Subject: [PATCH 13/17] Remove outdated comment --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 88e500c02..635391897 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,6 @@ author = 'Osma Suominen' # Get version number from GitHub tag -# The full version, including alpha/beta/rc tags. release = re.sub( '^v', '', From 01b0c7b9306da8465fabcde5b6e67afcaf85d5a0 Mon Sep 17 00:00:00 2001 From: Juho Inkinen Date: Fri, 31 May 2019 14:21:46 +0300 Subject: [PATCH 14/17] Delete file --- docs/make.bat | 35 ----------------------------------- 1 file changed, 35 deletions(-) delete mode 100644 docs/make.bat diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 27f573b87..000000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=. -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% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% - -:end -popd From 81933d1b2c9f806452bbd4e5a6cdfde1874981e1 Mon Sep 17 00:00:00 2001 From: Juho Inkinen Date: Wed, 5 Jun 2019 16:23:01 +0300 Subject: [PATCH 15/17] Explicitly assign master doc to try fix "contents.rst not found" --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 635391897..641f62a95 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -34,6 +34,8 @@ # -- General configuration --------------------------------------------------- +master_doc = 'index' + # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. From 0f8b81c9522438017468fac35756d330cab7c969 Mon Sep 17 00:00:00 2001 From: Juho Inkinen Date: Mon, 10 Jun 2019 09:20:07 +0300 Subject: [PATCH 16/17] Attempt build in readtheodocs with requirements files (Pipfiles not supported) --- requirements-dev.txt | 21 +++++++++++++++++++++ requirements.txt | 22 ++++++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 requirements-dev.txt create mode 100644 requirements.txt diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 000000000..626bad7d2 --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,21 @@ +################################################################################ +# This requirements file has been automatically generated from `Pipfile` with +# `pipenv-to-requirements` +# +# +# This has been done to maintain backward compatibility with tools and services +# that do not support `Pipfile` yet. +# +# Do NOT edit it directly, use `pipenv install [-d]` to modify `Pipfile` and +# `Pipfile.lock` and then regenerate `requirements*.txt`. +################################################################################ + +bumpversion +codecov +pytest-cov +pytest-flask +pytest-pep8 +pytest-watch +sphinx +sphinx-rtd-theme +swagger-tester diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 000000000..beec080a5 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,22 @@ +################################################################################ +# This requirements file has been automatically generated from `Pipfile` with +# `pipenv-to-requirements` +# +# +# This has been done to maintain backward compatibility with tools and services +# that do not support `Pipfile` yet. +# +# Do NOT edit it directly, use `pipenv install [-d]` to modify `Pipfile` and +# `Pipfile.lock` and then regenerate `requirements*.txt`. +################################################################################ + +-e . +click-log +connexion[swagger-ui] +flask-cors +gensim +joblib +nltk +rdflib +sklearn +swagger-ui-bundle From 21a2fb9b64fbb5050c248ba35dcb67ee252ccd46 Mon Sep 17 00:00:00 2001 From: Juho Inkinen Date: Mon, 10 Jun 2019 09:27:55 +0300 Subject: [PATCH 17/17] Add package to autocreate requirements files --- Pipfile | 1 + 1 file changed, 1 insertion(+) diff --git a/Pipfile b/Pipfile index 1d2b2f5b1..98e33ed98 100644 --- a/Pipfile +++ b/Pipfile @@ -13,6 +13,7 @@ swagger-tester = "*" bumpversion = "*" sphinx = "*" sphinx-rtd-theme = "*" +pipenv-to-requirements = "*" [packages] "e1839a8" = {editable = true, path = "."}