Mercurial > libervia-backend

comparison doc/conf.py @ 3605:62e81b1058f8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
author Goffi <goffi@goffi.org>
date Thu, 29 Jul 2021 22:51:01 +0200
parents 4705f80b6e23
children 4b8776eb6826
comparison
equal deleted inserted replaced
3604:80815f2f12cf 3605:62e81b1058f8
10 10
11 # If extensions (or modules to document with autodoc) are in another directory, 11 # If extensions (or modules to document with autodoc) are in another directory,
12 # add these directories to sys.path here. If the directory is relative to the 12 # add these directories to sys.path here. If the directory is relative to the
13 # documentation root, use os.path.abspath to make it absolute, like shown here. 13 # documentation root, use os.path.abspath to make it absolute, like shown here.
14 # 14 #
15 # import os 15 import os
16 # import sys 16 import sys
17 # sys.path.insert(0, os.path.abspath('.'))
18 import os.path 17 import os.path
19 import re 18 import re
19
20
21 sys.path.insert(0, os.path.abspath("./_ext"))
20 22
21 23
22 # -- Project information ----------------------------------------------------- 24 # -- Project information -----------------------------------------------------
23 25
24 project = 'Libervia' 26 project = 'Libervia'
45 47
46 # Add any Sphinx extension module names here, as strings. They can be 48 # Add any Sphinx extension module names here, as strings. They can be
47 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 49 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
48 # ones. 50 # ones.
49 extensions = [ 51 extensions = [
52 "sphinx.ext.autodoc",
53 "docstring"
50 ] 54 ]
51 55
52 # Add any paths that contain templates here, relative to this directory. 56 # Add any paths that contain templates here, relative to this directory.
53 templates_path = ['.templates'] 57 templates_path = ['.templates']
54 58