1 # -*- coding: utf-8 -*-

     2 #

     3 # Configuration file for the Sphinx documentation builder.

     4 #

     5 # This file does only contain a selection of the most common options. For a

     6 # full list see the documentation:

     7 # http://www.sphinx-doc.org/en/stable/config

     8 

     9 # -- Path setup --------------------------------------------------------------

    10 

    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

    13 # documentation root, use os.path.abspath to make it absolute, like shown here.

    14 #

    15 import os

    16 import sys

    17 

    18 import django

    19 

    20 sys.path.insert(0, os.path.abspath('../../src'))

    21 sys.setrecursionlimit(1500)

    22 

    23 os.environ['DJANGO_SETTINGS_MODULE'] = 'hdalab.settings'

    24 django.setup()

    25 

    26 # -- Project information -----------------------------------------------------

    27 

    28 project = u'HDALab'

    29 copyright = u'2018, IRI'

    30 author = u'Yves-Marie Haussonne'

    31 

    32 # The short X.Y version

    33 version = u''

    34 # The full version, including alpha/beta/rc tags

    35 release = u'3.2.1'

    36 

    37 

    38 # -- General configuration ---------------------------------------------------

    39 

    40 # If your documentation needs a minimal Sphinx version, state it here.

    41 #

    42 # needs_sphinx = '1.0'

    43 

    44 # Add any Sphinx extension module names here, as strings. They can be

    45 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

    46 # ones.

    47 extensions = [

    48     'sphinx.ext.autodoc',

    49     'sphinx.ext.todo',

    50     'sphinx.ext.viewcode',

    51 ]

    52 

    53 # Add any paths that contain templates here, relative to this directory.

    54 templates_path = ['_templates']

    55 

    56 # The suffix(es) of source filenames.

    57 # You can specify multiple suffix as a list of string:

    58 #

    59 # source_suffix = ['.rst', '.md']

    60 source_suffix = '.rst'

    61 

    62 # The master toctree document.

    63 master_doc = 'index'

    64 

    65 # The language for content autogenerated by Sphinx. Refer to documentation

    66 # for a list of supported languages.

    67 #

    68 # This is also used if you do content translation via gettext catalogs.

    69 # Usually you set "language" from the command line for these cases.

    70 language = u'fr'

    71 

    72 # List of patterns, relative to source directory, that match files and

    73 # directories to ignore when looking for source files.

    74 # This pattern also affects html_static_path and html_extra_path .

    75 exclude_patterns = []

    76 

    77 # The name of the Pygments (syntax highlighting) style to use.

    78 pygments_style = 'sphinx'

    79 

    80 

    81 # -- Options for HTML output -------------------------------------------------

    82 

    83 # The theme to use for HTML and HTML Help pages.  See the documentation for

    84 # a list of builtin themes.

    85 #

    86 html_theme = 'alabaster'

    87 

    88 # Theme options are theme-specific and customize the look and feel of a theme

    89 # further.  For a list of options available for each theme, see the

    90 # documentation.

    91 #

    92 # html_theme_options = {}

    93 

    94 # Add any paths that contain custom static files (such as style sheets) here,

    95 # relative to this directory. They are copied after the builtin static files,

    96 # so a file named "default.css" will overwrite the builtin "default.css".

    97 html_static_path = ['_static']

    98 

    99 # Custom sidebar templates, must be a dictionary that maps document names

   100 # to template names.

   101 #

   102 # The default sidebars (for documents that don't match any pattern) are

   103 # defined by theme itself.  Builtin themes are using these templates by

   104 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',

   105 # 'searchbox.html']``.

   106 #

   107 # html_sidebars = {}

   108 

   109 

   110 # -- Options for HTMLHelp output ---------------------------------------------

   111 

   112 # Output file base name for HTML help builder.

   113 htmlhelp_basename = 'HDALabdoc'

   114 

   115 

   116 # -- Options for LaTeX output ------------------------------------------------

   117 

   118 latex_elements = {

   119     # The paper size ('letterpaper' or 'a4paper').

   120     #

   121     # 'papersize': 'letterpaper',

   122 

   123     # The font size ('10pt', '11pt' or '12pt').

   124     #

   125     # 'pointsize': '10pt',

   126 

   127     # Additional stuff for the LaTeX preamble.

   128     #

   129     # 'preamble': '',

   130 

   131     # Latex figure (float) alignment

   132     #

   133     # 'figure_align': 'htbp',

   134 }

   135 

   136 # Grouping the document tree into LaTeX files. List of tuples

   137 # (source start file, target name, title,

   138 #  author, documentclass [howto, manual, or own class]).

   139 latex_documents = [

   140     (master_doc, 'HDALab.tex', u'HDALab Documentation',

   141      u'ymh', 'manual'),

   142 ]

   143 

   144 

   145 # -- Options for manual page output ------------------------------------------

   146 

   147 # One entry per manual page. List of tuples

   148 # (source start file, name, description, authors, manual section).

   149 man_pages = [

   150     (master_doc, 'hdalab', u'HDALab Documentation',

   151      [author], 1)

   152 ]

   153 

   154 

   155 # -- Options for Texinfo output ----------------------------------------------

   156 

   157 # Grouping the document tree into Texinfo files. List of tuples

   158 # (source start file, target name, title, author,

   159 #  dir menu entry, description, category)

   160 texinfo_documents = [

   161     (master_doc, 'HDALab', u'HDALab Documentation',

   162      author, 'HDALab', 'One line description of project.',

   163      'Miscellaneous'),

   164 ]

   165 

   166 

   167 # -- Extension configuration -------------------------------------------------

   168 

   169 # -- Options for todo extension ----------------------------------------------

   170 

   171 # If true, `todo` and `todoList` produce output, else they produce nothing.

   172 todo_include_todos = True

   173 

   174 # True to prefix each section label with the name of the document it is in, followed by a colon.

   175 # For example, index:Introduction for a section called Introduction that appears in document index.rst.

   176 # Useful for avoiding ambiguity when the same section heading appears in different documents.

   177 

   178 autosectionlabel_prefix_document = True

   179 

   180 

   181 autodoc_mock_imports = ["haystack.backends.whoosh_backend.SearchBackend"]

   182 

   183 html_theme_options = {

   184     'logo': 'img/logo_iri.png',

   185 }

   186 

   187 html_sidebars = {

   188     '**': [

   189         'about.html',

   190         'localtoc.html',

   191         'relations.html',

   192         # 'sourcelink.html',

   193         'searchbox.html'

   194     ]

   195 }