Skip to content
Snippets Groups Projects
Select Git revision
  • 12f00b414bc43b0d85cb401c5adb4aded08a3cd1
  • master default protected
  • sdptr_lift
  • v1.5.0
  • v1.4.0
  • v1.3.0
  • v1.2.0
  • v1.1.2
  • v1.1.1
  • v1.1.0
  • v1.0.0
11 results

fpga.cpp

Blame
  • Code owners
    Assign users and groups as approvers for specific file changes. Learn more.
    conf.py 10.48 KiB
    # -*- coding: utf-8 -*-
    #
    # SKA Tango Base documentation build configuration file, created by
    # sphinx-quickstart on Fri Jan 11 10:03:42 2019.
    #
    # This file is execfile()d with the current directory set to its
    # containing dir.
    #
    # Note that not all possible configuration values are present in this
    # autogenerated file.
    #
    # All configuration values have a default; values that are commented out
    # serve to show the default.
    
    import os
    import sys
    
    # This is an elaborate hack to insert write property into _all_
    # mock decorators. It is needed for getting @command to build
    # in mocked out tango.server.  Also add dummy classes for
    # attribute and device_property so that they at least
    # appear in the docs, even if there is not other useful info.
    # see https://github.com/sphinx-doc/sphinx/issues/6709
    from sphinx.ext.autodoc.mock import _MockObject
    
    
    def get_kwarg_comma_separated_values(kwargs):
        pairs = (f"{key}={value}" for key, value in kwargs.items())
        return ", ".join(pairs)
    
    
    class TangoKwargMethodMock:
        def __init__(self, name, **kwargs):
            self.name = name
            self.kwargs = kwargs
    
        def __repr__(self):
            return f"{self.name}({get_kwarg_comma_separated_values(self.kwargs)})"
    
    
    def call_mock(self, *args, **kw):
        from types import FunctionType, MethodType
    
        if args and type(args[0]) in [type, FunctionType, MethodType]:
            # Appears to be a decorator, pass through unchanged
            args[0].write = lambda x: x
            return args[0]
    
        if repr(self) in ['tango.server.attribute', 'tango.server.device_property']:
            return TangoKwargMethodMock(repr(self), **kw)
    
        return self
    
    
    _MockObject.__call__ = call_mock
    # hack end
    
    autodoc_mock_imports = [
        'tango',
        'transitions',
        'ska_ser_logging',
        'numpy',
    ]
    
    autodoc_default_options = {
        'member-order': 'bysource',
    }
    
    
    # Both the class’ and the __init__ method’s docstring are concatenated and inserted.
    autoclass_content = 'both'
    
    
    def setup(app):
        """
        Initialise app.
        """
        app.add_css_file("css/custom.css")
        app.add_js_file("js/gitlab.js")
    
    
    # -- Path set up --------------------------------------------------------------
    # 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.
    sys.path.insert(0, os.path.abspath('../../src'))
    
    # -- General configuration ------------------------------------------------
    
    # If your documentation needs a minimal Sphinx version, state it here.
    needs_sphinx = '3.5'
    
    # 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.ext.autodoc',
        'sphinx.ext.doctest',
        'sphinx.ext.todo',
        'sphinx.ext.coverage',
        'sphinx.ext.viewcode',
    ]
    
    # Add any paths that contain templates here, relative to this directory.
    templates_path = ['_templates']
    
    # The suffix of source filenames.
    source_suffix = '.rst'
    
    # The encoding of source files.
    #source_encoding = 'utf-8-sig'
    
    # The master toctree document.
    master_doc = 'index'
    
    # General information about the project.
    project = u'SKA Tango Base'
    
    # The version info for the project you're documenting, acts as replacement for
    # |version| and |release|, also used in various other places throughout the
    # built documents.
    #
    
    def get_release_info():
        release_filename = os.path.join("..", "..", "src", "ska_tango_base", "release.py")
        exec(open(release_filename).read())
        return locals()
    
    
    release_info = get_release_info()
    copyright = release_info["copyright"]
    
    # The short X.Y version.
    version = release_info["version"]
    # The full version, including alpha/beta/rc tags.
    release = release_info["version"]
    
    # The language for content autogenerated by Sphinx. Refer to documentation
    # for a list of supported languages.
    #language = None
    
    # There are two options for replacing |today|: either, you set today to some
    # non-false value, then it is used:
    #today = ''
    # Else, today_fmt is used as the format for a strftime call.
    #today_fmt = '%B %d, %Y'
    
    # List of patterns, relative to source directory, that match files and
    # directories to ignore when looking for source files.
    exclude_patterns = []
    
    # The reST default role (used for this markup: `text`) to use for all
    # documents.
    #default_role = None
    
    # If true, '()' will be appended to :func: etc. cross-reference text.
    #add_function_parentheses = True
    
    # If true, the current module name will be prepended to all description
    # unit titles (such as .. function::).
    #add_module_names = True
    
    # If true, sectionauthor and moduleauthor directives will be shown in the
    # output. They are ignored by default.
    #show_authors = False
    
    # The name of the Pygments (syntax highlighting) style to use.
    pygments_style = 'sphinx'
    
    # A list of ignored prefixes for module index sorting.
    #modindex_common_prefix = []
    
    # If true, keep warnings as "system message" paragraphs in the built documents.
    #keep_warnings = False
    
    # -- 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 themes here, relative to this directory.
    #html_theme_path = []
    
    # The name for this set of Sphinx documents.  If None, it defaults to
    # "<project> v<release> documentation".
    #html_title = None
    
    # A shorter title for the navigation bar.  Default is the same as html_title.
    #html_short_title = None
    
    # The name of an image file (relative to this directory) to place at the top
    # of the sidebar.
    #html_logo = None
    
    # The name of an image file (within the static path) to use as favicon of the
    # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
    # pixels large.
    #html_favicon = None
    
    html_context = {
        "display_gitlab": True,  # Integrate GitHub
        "favicon": "img/favicon.ico",
        "logo": "img/logo.jpg",
        "theme_logo_only": True,
        "gitlab_user": "ska-telescope",  # Username
        "gitlab_repo": "ska-tango-base",  # Repo name
        "gitlab_version": "master",  # Version
        "conf_py_path": "/docs/source/",  # Path in the checkout to the docs root
    }
    
    
    # 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']
    
    # Add any extra paths that contain custom files (such as robots.txt or
    # .htaccess) here, relative to this directory. These files are copied
    # directly to the root of the documentation.
    #html_extra_path = []
    
    # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
    # using the given strftime format.
    #html_last_updated_fmt = '%b %d, %Y'
    
    # If true, SmartyPants will be used to convert quotes and dashes to
    # typographically correct entities.
    #html_use_smartypants = True
    
    # Custom sidebar templates, maps document names to template names.
    #html_sidebars = {}
    
    # Additional templates that should be rendered to pages, maps page names to
    # template names.
    #html_additional_pages = {}
    
    # If false, no module index is generated.
    #html_domain_indices = True
    
    # If false, no index is generated.
    #html_use_index = True
    
    # If true, the index is split into individual pages for each letter.
    #html_split_index = False
    
    # If true, links to the reST sources are added to the pages.
    #html_show_sourcelink = True
    
    # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
    #html_show_sphinx = True
    
    # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
    #html_show_copyright = True
    
    # If true, an OpenSearch description file will be output, and all pages will
    # contain a <link> tag referring to it.  The value of this option must be the
    # base URL from which the finished HTML is served.
    #html_use_opensearch = ''
    
    # This is the file name suffix for HTML files (e.g. ".xhtml").
    #html_file_suffix = None
    
    # Output file base name for HTML help builder.
    htmlhelp_basename = 'SKA_TangoBasedoc'
    
    
    # -- 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': '',
    }
    
    # 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 = [
        ('index', 'SKA_TangoBase.tex', u'SKA Tango Base Documentation',
         u'NCRA India', 'manual'),
    ]
    
    # The name of an image file (relative to this directory) to place at the top of
    # the title page.
    #latex_logo = None
    
    # For "manual" documents, if this is true, then toplevel headings are parts,
    # not chapters.
    #latex_use_parts = False
    
    # If true, show page references after internal links.
    #latex_show_pagerefs = False
    
    # If true, show URL addresses after external links.
    #latex_show_urls = False
    
    # Documents to append as an appendix to all manuals.
    #latex_appendices = []
    
    # If false, no module index is generated.
    #latex_domain_indices = True
    
    
    # -- Options for manual page output ---------------------------------------
    
    # One entry per manual page. List of tuples
    # (source start file, name, description, authors, manual section).
    man_pages = [
        ('index', 'ska_tango_base', u'SKA Tango Base Documentation',
         [u'NCRA India'], 1)
    ]
    
    # If true, show URL addresses after external links.
    #man_show_urls = False
    
    
    # -- 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 = [
        ('index', 'SKA_TangoBase', u'SKA Tango Base Documentation',
         u'NCRA India', 'SKA_TangoBase', 'One line description of project.',
         'Miscellaneous'),
    ]
    
    # Documents to append as an appendix to all manuals.
    #texinfo_appendices = []
    
    # If false, no module index is generated.
    #texinfo_domain_indices = True
    
    # How to display URL addresses: 'footnote', 'no', or 'inline'.
    #texinfo_show_urls = 'footnote'
    
    # If true, do not generate a @detailmenu in the "Top" node's menu.
    #texinfo_no_detailmenu = False