/ doc / conf.py
conf.py
 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  # https://www.sphinx-doc.org/en/master/usage/configuration.html
 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 sys
15  sys.path.insert(0, os.path.abspath('../DAS'))
16  
17  
18  # -- Project information -----------------------------------------------------
19  
20  project = 'DAS simulator'
21  copyright = '2023, Leonardo A. Bautista-Gomez, Csaba Kiraly'
22  author = 'Leonardo A. Bautista-Gomez, Csaba Kiraly'
23  
24  # The full version, including alpha/beta/rc tags
25  release = '1'
26  
27  
28  # -- General configuration ---------------------------------------------------
29  
30  # Add any Sphinx extension module names here, as strings. They can be
31  # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32  # ones.
33  extensions = ['sphinx.ext.autodoc'
34  ]
35  
36  
37  # Add any paths that contain templates here, relative to this directory.
38  templates_path = ['_templates']
39  
40  # List of patterns, relative to source directory, that match files and
41  # directories to ignore when looking for source files.
42  # This pattern also affects html_static_path and html_extra_path.
43  exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'myenv']
44  
45  
46  # -- Options for HTML output -------------------------------------------------
47  
48  # The theme to use for HTML and HTML Help pages.  See the documentation for
49  # a list of builtin themes.
50  #
51  html_theme = 'alabaster'
52  
53  # Add any paths that contain custom static files (such as style sheets) here,
54  # relative to this directory. They are copied after the builtin static files,
55  # so a file named "default.css" will overwrite the builtin "default.css".
56  html_static_path = ['_static']
57  
58  
59  # -- Options for autodoc -------------------------------------------------
60  
61  autodoc_mock_imports = ["django", "dicttoxml", "bitarray", "DAS", "networkx"]
62  
63  
64