galette/docs/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('.'))
  16
  17
  18 # -- Project information -----------------------------------------------------
  19
  20 project = 'Galette API'
  21 copyright = '2020, Johan Cwiklinski'
  22 author = 'Johan Cwiklinski'
  23
  24 import subprocess
  25 subprocess.call('doxygen', shell=True)
  26
  27 master_doc = 'index'
  28
  29 # The full version, including alpha/beta/rc tags
  30 release = '0.9.4.1'
  31
  32
  33 # -- General configuration ---------------------------------------------------
  34
  35 # Add any Sphinx extension module names here, as strings. They can be
  36 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  37 # ones.
  38 #extensions = [
  39 #    'breathe'
  40 #]
  41
  42 # Breathe Configuration
  43 #breathe_projects = { "galette": "./apidocs/xml/" }
  44 #breathe_default_project = "galette"
  45
  46 # Add any paths that contain templates here, relative to this directory.
  47 #templates_path = ['source/_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 = ['apidocs/']
  53 html_extra_path = ['apidocs/html']
  54
  55
  56 # -- Options for HTML output -------------------------------------------------
  57
  58 # The theme to use for HTML and HTML Help pages.  See the documentation for
  59 # a list of builtin themes.
  60 #
  61 html_theme = 'alabaster'
  62
  63 # Add any paths that contain custom static files (such as style sheets) here,
  64 # relative to this directory. They are copied after the builtin static files,
  65 # so a file named "default.css" will overwrite the builtin "default.css".
  66 #html_static_path = ['source/_static']