-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #280 from NatLibFi/issue277-auto-generate-api-docu…
…mentation Issue277 auto generate api documentation
- Loading branch information
Showing
13 changed files
with
457 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,7 @@ __pycache__ | |
.pytest_cache | ||
*.pyc | ||
data | ||
docs/_build/ | ||
Pipfile.lock | ||
projects.cfg | ||
venv/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# 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 re | ||
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' | ||
|
||
# Get version number from GitHub tag | ||
release = re.sub( | ||
'^v', | ||
'', | ||
os.popen('git describe --tags --abbrev=0').read().strip() | ||
) | ||
# The short X.Y version. | ||
version = release | ||
|
||
|
||
# -- 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. | ||
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 = '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, | ||
# so a file named "default.css" will overwrite the builtin "default.css". | ||
html_static_path = ['_static'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
.. 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 API documentation! | ||
===================================== | ||
|
||
See `installation instructions <https://github.com/NatLibFi/Annif/blob/master/README.md>`_ and `Wiki pages <https://github.com/NatLibFi/Annif/wiki>`_ in GitHub, and also http://annif.org/. | ||
|
||
You are reading documentation for version |version|. | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Annif API Reference: | ||
|
||
source/annif | ||
|
||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: |
Oops, something went wrong.