Skip to content
Snippets Groups Projects
Select Git revision
  • f9147dd7a7d355534c9e42cc8d16759bd9a7634f
  • main default protected
  • dev protected
  • f-render-html-properties
  • f-vishesh0932-ext-cosmetics
  • f-table-references
  • f-update-legacy-adapter
  • f-refactor-refs
  • f-fix-caosadvancedtools-refs
  • f-linkahead-rename
  • f-citation-cff
  • f-map-resolve-reference
  • dev-bmpg
  • f-form-select
  • f-doc-extention
  • f-geo-position-records
  • f-data-analysis
  • f-area-folder-drop
  • f-fix-get-parents
  • f-fix-110
  • f-entity-state
  • v0.16.0
  • v0.15.2
  • v0.15.1
  • v0.15.0
  • v0.14.0
  • v0.13.3
  • v0.13.2
  • v0.13.1
  • v0.13.0
  • v0.12.0
  • v0.11.1
  • v0.11.0
  • v0.10.1
  • v0.10.0
  • v0.9.0
  • v0.8.0
  • v0.7.0
  • v0.6.0
  • v0.5.0
  • v0.4.2
41 results

conf.py

Blame
  • Code owners
    Assign users and groups as approvers for specific file changes. Learn more.
    conf.py 6.23 KiB
    # -*- coding: utf-8 -*-
    #
    # Configuration file for the Sphinx documentation builder.
    #
    # This file only contains a selection of the most common options. For a full
    # list see the documentation:
    # https://www.sphinx-doc.org/en/master/usage/configuration.html
    
    # -- Path setup --------------------------------------------------------------
    
    # If extensions (or modules to document with autodoc) are in another directory,
    # add these directories to sys.path here. If the directory is relative to the
    # documentation root, use os.path.abspath to make it absolute, like shown here.
    #
    # import os
    # import sys
    # sys.path.insert(0, os.path.abspath('../caosdb'))
    
    
    # -- Project information -----------------------------------------------------
    
    import sphinx_rtd_theme
    
    project = 'caosdb-webui'
    copyright = '2020, IndiScale GmbH'
    author = 'Daniel Hornung'
    
    # The short X.Y version
    version = '0.X.Y'
    # The full version, including alpha/beta/rc tags
    release = '0.x.y-beta-rc2'
    
    
    # -- General configuration ---------------------------------------------------
    
    # If your documentation needs a minimal Sphinx version, state it here.
    #
    # needs_sphinx = '1.0'
    
    # Add any Sphinx extension module names here, as strings. They can be
    # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
    # ones.
    extensions = [
    #    'sphinx_js',
        'sphinx.ext.todo',
        "sphinx.ext.autodoc",
    #    'autoapi.extension',
        "recommonmark",            # For markdown files.
        "sphinx_rtd_theme",
        'sphinx.ext.intersphinx',
        'sphinx.ext.mathjax',
        'sphinx.ext.ifconfig',
        # 'sphinx.ext.napoleon',     # For Google style docstrings
    ]
    
    # Add any paths that contain templates here, relative to this directory.
    templates_path = ['_templates']
    
    # The suffix(es) of source filenames.
    # You can specify multiple suffix as a list of string:
    #
    # source_suffix = ['.rst', '.md']
    source_suffix = '.rst'
    
    # The master toctree document.
    master_doc = 'index'
    
    # The language for content autogenerated by Sphinx. Refer to documentation
    # for a list of supported languages.
    #
    # This is also used if you do content translation via gettext catalogs.
    # Usually you set "language" from the command line for these cases.
    language = None
    
    # List of patterns, relative to source directory, that match files and
    # directories to ignore when looking for source files.
    # This pattern also affects html_static_path and html_extra_path.
    exclude_patterns = []
    
    # The name of the Pygments (syntax highlighting) style to use.
    pygments_style = None
    
    
    # -- Options for HTML output -------------------------------------------------
    
    # The theme to use for HTML and HTML Help pages.  See the documentation for
    # a list of builtin themes.
    #
    html_theme = "sphinx_rtd_theme"
    
    # Theme options are theme-specific and customize the look and feel of a theme
    # further.  For a list of options available for each theme, see the
    # documentation.
    #
    # html_theme_options = {}
    
    # Add any paths that contain custom static files (such as style sheets) here,
    # relative to this directory. They are copied after the builtin static files,
    # so a file named "default.css" will overwrite the builtin "default.css".
    # html_static_path = ['_static']
    
    # Custom sidebar templates, must be a dictionary that maps document names
    # to template names.
    #
    # The default sidebars (for documents that don't match any pattern) are
    # defined by theme itself.  Builtin themes are using these templates by
    # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
    # 'searchbox.html']``.
    #
    # html_sidebars = {}
    
    
    # -- Options for HTMLHelp output ---------------------------------------------
    
    # Output file base name for HTML help builder.
    htmlhelp_basename = 'caosdb-webuidoc'
    
    
    # -- Options for LaTeX output ------------------------------------------------
    
    latex_elements = {
        # The paper size ('letterpaper' or 'a4paper').
        #
        # 'papersize': 'letterpaper',
    
        # The font size ('10pt', '11pt' or '12pt').
        #
        # 'pointsize': '10pt',
    
        # Additional stuff for the LaTeX preamble.
        #
        # 'preamble': '',
    
        # Latex figure (float) alignment
        #
        # 'figure_align': 'htbp',
    }
    
    # Grouping the document tree into LaTeX files. List of tuples
    # (source start file, target name, title,
    #  author, documentclass [howto, manual, or own class]).
    latex_documents = [
        (master_doc, 'caosdb-webui.tex', 'caosdb-webui Documentation',
         'IndiScale GmbH', 'manual'),
    ]
    
    
    # -- Options for manual page output ------------------------------------------
    
    # One entry per manual page. List of tuples
    # (source start file, name, description, authors, manual section).
    man_pages = [
        (master_doc, 'caosdb-webui', 'caosdb-webui Documentation',
         [author], 1)
    ]
    
    
    # -- Options for Texinfo output ----------------------------------------------
    
    # Grouping the document tree into Texinfo files. List of tuples
    # (source start file, target name, title, author,
    #  dir menu entry, description, category)
    texinfo_documents = [
        (master_doc, 'caosdb-webui', 'caosdb-webui Documentation',
         author, 'caosdb-webui', 'One line description of project.',
         'Miscellaneous'),
    ]
    
    
    # -- Options for Epub output -------------------------------------------------
    
    # Bibliographic Dublin Core info.
    epub_title = project
    
    # The unique identifier of the text. This can be a ISBN number
    # or the project homepage.
    #
    # epub_identifier = ''
    
    # A unique identification for the text.
    #
    # epub_uid = ''
    
    # A list of files that should not be packed into the epub file.
    epub_exclude_files = ['search.html']
    
    
    # -- Extension configuration -------------------------------------------------
    
    # -- Options for sphinx-js ---------------------------------------------------
    # See also https://pypi.org/project/sphinx-js/
    
    js_source_path = '../core/js/'
    primary_domain = 'js'  # Not strictly necessary?
    
    # -- Options for intersphinx extension ---------------------------------------
    
    # Example configuration for intersphinx: refer to the Python standard library.
    intersphinx_mapping = {'https://docs.python.org/': None}
    
    # TODO Which options do we want?
    autodoc_default_options = {
        'members': None,
        'undoc-members': None,
    }
    
    # -- Options for sphinx-autoapi ----------------------------------------------
    # See also https://pypi.org/project/sphinx-js/
    
    autoapi_type = 'javascript'
    autoapi_dirs = ['../core/js/']
    autoapi_add_toctree_entry = False