1
|
|
|
# Configuration file for the Sphinx documentation builder. |
2
|
|
|
# |
3
|
|
|
# This file only contains a selection of the most common options. For a full |
4
|
|
|
# list see the documentation: |
5
|
|
|
# http://www.sphinx-doc.org/en/master/config |
6
|
|
|
|
7
|
|
|
# -- Path setup -------------------------------------------------------------- |
8
|
|
|
|
9
|
|
|
# If extensions (or modules to document with autodoc) are in another directory, |
10
|
|
|
# add these directories to sys.path here. If the directory is relative to the |
11
|
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here. |
12
|
|
|
# |
13
|
|
|
import os |
14
|
|
|
import re |
15
|
|
|
import sys |
16
|
|
|
sys.path.insert(0, os.path.abspath('..')) |
17
|
|
|
|
18
|
|
|
|
19
|
|
|
# -- Project information ----------------------------------------------------- |
20
|
|
|
|
21
|
|
|
project = 'annif' |
22
|
|
|
copyright = '2017, University Of Helsinki (The National Library Of Finland)' |
23
|
|
|
author = 'Osma Suominen' |
24
|
|
|
|
25
|
|
|
# Get version number from GitHub tag |
26
|
|
|
release = re.sub( |
27
|
|
|
'^v', |
28
|
|
|
'', |
29
|
|
|
os.popen('git describe --tags --abbrev=0').read().strip() |
30
|
|
|
) |
31
|
|
|
# The short X.Y version. |
32
|
|
|
version = release |
33
|
|
|
|
34
|
|
|
|
35
|
|
|
# -- General configuration --------------------------------------------------- |
36
|
|
|
|
37
|
|
|
master_doc = 'index' |
38
|
|
|
|
39
|
|
|
# Add any Sphinx extension module names here, as strings. They can be |
40
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
41
|
|
|
# ones. |
42
|
|
|
extensions = [ |
43
|
|
|
'sphinx.ext.autodoc' |
44
|
|
|
] |
45
|
|
|
|
46
|
|
|
# Add any paths that contain templates here, relative to this directory. |
47
|
|
|
templates_path = ['_templates'] |
48
|
|
|
|
49
|
|
|
# List of patterns, relative to source directory, that match files and |
50
|
|
|
# directories to ignore when looking for source files. |
51
|
|
|
# This pattern also affects html_static_path and html_extra_path. |
52
|
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
53
|
|
|
|
54
|
|
|
|
55
|
|
|
# -- Options for HTML output ------------------------------------------------- |
56
|
|
|
|
57
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for |
58
|
|
|
# a list of builtin themes. |
59
|
|
|
# |
60
|
|
|
html_theme = 'sphinx_rtd_theme' |
61
|
|
|
|
62
|
|
|
# Add any paths that contain custom static files (such as style sheets) here, |
63
|
|
|
# relative to this directory. They are copied after the builtin static files, |
64
|
|
|
# so a file named "default.css" will overwrite the builtin "default.css". |
65
|
|
|
html_static_path = ['_static'] |
66
|
|
|
|