conf.py

# -*- coding: utf-8 -*-
#
# sphynx-demo documentation build configuration file, created by
# sphinx-quickstart on Tue Aug  2 16:48:54 2016.
#
# 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.

# 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 sys
# sys.path.insert(0, os.path.abspath('.'))
import os
import pathlib
import shutil
import subprocess
import sys

import git

import requests


def setup(app):
    # Add property to avoid warning.
    app.add_config_value('skip_python', None, '')


def download_css(html_css_dir):
    """
    Download the common theme of eProsima readthedocs documentation.

    The theme is defined in a CSS file that is hosted in the eProsima GitHub
    repository with the index of all eProsima product documentation
    (https://github.com/eProsima/all-docs).

    :param html_css_dir: The directory to save the CSS stylesheet.
    :return: True if the file was downloaded and generated successfully.
        False if not.
    """
    url = (
        'https://raw.githubusercontent.com/eProsima/all-docs/'
        'master/source/_static/css/fiware_readthedocs.css')
    try:
        req = requests.get(url, allow_redirects=True, timeout=10)
    except requests.RequestException as e:
        print(
            'Failed to download the CSS with the eProsima rtd theme.'
            'Request Error: {}'.format(e)
        )
        return False
    if req.status_code != 200:
        print(
            'Failed to download the CSS with the eProsima rtd theme.'
            'Return code: {}'.format(req.status_code))
        return False
    os.makedirs(
        os.path.dirname('{}/_static/css/'.format(html_css_dir)),
        exist_ok=True)
    theme_path = '{}/_static/css/eprosima_rtd_theme.css'.format(html_css_dir)
    with open(theme_path, 'wb') as f:
        try:
            f.write(req.content)
        except OSError:
            print('Failed to create the file: {}'.format(theme_path))
            return False
    return True


def select_css(html_css_dir):
    """
    Select CSS file with the website's template.

    :param html_css_dir: The directory to save the CSS stylesheet.
    :return: Returns a list of CSS files to be imported.
    """
    ret = ['_static/tabs.css']
    common_css = '_static/css/eprosima_rtd_theme.css'
    local_css = '_static/css/fiware_readthedocs.css'
    if download_css(html_css_dir):
        print('Applying common CSS style file: {}'.format(common_css))
        ret.append(common_css)
    else:
        print('Applying local CSS style file: {}'.format(local_css))
        ret.append(local_css)

    return ret


def get_git_branch():
    """Get the git branch this repository is currently on."""
    path_to_here = os.path.abspath(os.path.dirname(__file__))

    # Invoke git to get the current branch which we use to get the theme
    try:
        p = subprocess.Popen(
            ['git', 'rev-parse', '--verify', 'HEAD'],
            stdout=subprocess.PIPE,
            cwd=path_to_here
        )

        commit = p.communicate()[0].decode().rstrip()

        p = subprocess.Popen(
            ['git', 'name-rev', '--name-only', commit],
            stdout=subprocess.PIPE,
            cwd=path_to_here
        )

        return p.communicate()[0].decode().rstrip()

    except Exception:
        print('Could not get the branch')

    # Couldn't figure out the branch probably due to an error
    return None


def configure_doxyfile(
    doxyfile_in,
    doxyfile_out,
    input_dir,
    output_dir,
    project_binary_dir,
    project_source_dir
):
    """
    Configure Doxyfile in the CMake style.

    :param doxyfile_in: Path to input Doxygen configuration file
    :param doxyfile_out: Path to output Doxygen configuration file
    :param input_dir: CMakeLists.txt value of DOXYGEN_INPUT_DIR
    :param output_dir: CMakeLists.txt value of DOXYGEN_OUTPUT_DIR
    :param project_binary_dir: CMakeLists.txt value of PROJECT_BINARY_DIR
    :param project_source_dir: CMakeLists.txt value of PROJECT_SOURCE_DIR
    """
    print('Configuring Doxyfile')
    with open(doxyfile_in, 'r') as file:
        filedata = file.read()

    filedata = filedata.replace('@DOXYGEN_INPUT_DIR@', input_dir)
    filedata = filedata.replace('@DOXYGEN_OUTPUT_DIR@', output_dir)
    filedata = filedata.replace('@PROJECT_BINARY_DIR@', project_binary_dir)
    filedata = filedata.replace('@PROJECT_SOURCE_DIR@', project_source_dir)

    os.makedirs(os.path.dirname(doxyfile_out), exist_ok=True)
    with open(doxyfile_out, 'w') as file:
        file.write(filedata)


script_path = os.path.abspath(pathlib.Path(__file__).parent.absolute())
# Project directories
project_source_dir = os.path.abspath('{}/../code'.format(script_path))
project_binary_dir = os.path.abspath('{}/../build'.format(script_path))
output_dir = os.path.abspath('{}/doxygen'.format(project_binary_dir))
doxygen_html = os.path.abspath('{}/html/doxygen'.format(project_binary_dir))
fastdds_python_imported_location = None

# Doxyfile
doxyfile_in = os.path.abspath(
    '{}/doxygen-config.in'.format(project_source_dir)
)
doxyfile_out = os.path.abspath('{}/doxygen-config'.format(project_binary_dir))

# Header files
input_dir = os.path.abspath(
    '{}/fastdds/include/fastdds'.format(
        project_binary_dir
    )
)

# Check if we're running on Read the Docs' servers
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
if read_the_docs_build:
    print('Read the Docs environment detected!')

    fastdds_repo_name = os.path.abspath(
        '{}/fastdds'.format(
            project_binary_dir
        )
    )

    fastdds_python_repo_name = os.path.abspath(
        '{}/fastdds_python'.format(
            project_binary_dir
        )
    )

    # Remove repository if exists
    if os.path.isdir(fastdds_repo_name):
        print('Removing existing repository in {}'.format(fastdds_repo_name))
        shutil.rmtree(fastdds_repo_name)
    if os.path.isdir(fastdds_python_repo_name):
        print('Removing existing repository in {}'.format(
            fastdds_python_repo_name))
        shutil.rmtree(fastdds_python_repo_name)

    # Create necessary directory path
    os.makedirs(os.path.dirname(fastdds_repo_name), exist_ok=True)
    os.makedirs(os.path.dirname(fastdds_python_repo_name), exist_ok=True)

    # Clone repositories

    # - Fast DDS
    print('Cloning Fast DDS')
    fastdds = git.Repo.clone_from(
        'https://github.com/eProsima/Fast-DDS.git',
        fastdds_repo_name,
    )

    # Documentation repository branch
    docs_branch = get_git_branch()
    print('Current documentation branch is "{}"'.format(docs_branch))

    # User specified Fast DDS branch
    fastdds_branch = os.environ.get('FASTDDS_BRANCH', None)

    # First try to checkout to ${FASTDDS_BRANCH}
    # Else try with current documentation branch
    # Else checkout to master
    if (fastdds_branch and
            fastdds.refs.__contains__('origin/{}'.format(fastdds_branch))):
        fastdds_branch = 'origin/{}'.format(fastdds_branch)
    elif (docs_branch and
            fastdds.refs.__contains__('origin/{}'.format(docs_branch))):
        fastdds_branch = 'origin/{}'.format(docs_branch)
    else:
        print(
            'Fast DDS does not have either "{}" or "{}" branches'.format(
                fastdds_branch,
                docs_branch
            )
        )
        fastdds_branch = 'origin/master'

    # Actual checkout
    print('Checking out Fast DDS branch "{}"'.format(fastdds_branch))
    fastdds.refs[fastdds_branch].checkout()

    # - Fast DDS Python Bindings
    print('Cloning Fast DDS Python Bindings')
    fastdds_python = git.Repo.clone_from(
        'https://github.com/eProsima/Fast-DDS-python.git',
        fastdds_python_repo_name,
    )

    # User specified Fast DDS branch
    fastdds_python_branch = os.environ.get('FASTDDS_PYTHON_BRANCH', None)

    # First try to checkout to ${FASTDDS_PYTHON_BRANCH}
    # Else try with current documentation branch
    # Else checkout to master
    if (fastdds_python_branch and
            fastdds_python.refs.__contains__(
                'origin/{}'.format(fastdds_python_branch))):
        fastdds_python_branch = 'origin/{}'.format(fastdds_python_branch)
    elif (docs_branch and
            fastdds_python.refs.__contains__('origin/{}'.format(docs_branch))):
        fastdds_python_branch = 'origin/{}'.format(docs_branch)
    else:
        print(
            'Fast DDS Python does not have either "{}" or "{}" branches'
            .format(fastdds_python_branch, docs_branch))
        fastdds_python_branch = 'origin/main'

    # Actual checkout
    print('Checking out Fast DDS Python branch "{}"'.format(
        fastdds_python_branch))
    fastdds_python.refs[fastdds_python_branch].checkout()

    os.makedirs(os.path.dirname(output_dir), exist_ok=True)
    os.makedirs(os.path.dirname(doxygen_html), exist_ok=True)

    os.makedirs("{}/include/fastcdr".format(fastdds_repo_name), exist_ok=True)
    with open("{}/include/fastcdr/config.h".format(fastdds_repo_name), "w") as config_file:
        config_file.write("#define FASTCDR_VERSION_MAJOR 1")

    # Configure Doxyfile
    configure_doxyfile(
        doxyfile_in,
        doxyfile_out,
        input_dir,
        output_dir,
        project_binary_dir,
        project_source_dir
    )
    # Generate doxygen documentation
    doxygen_ret = subprocess.call('doxygen {}'.format(doxyfile_out), shell=True)
    if doxygen_ret != 0:
        print('Doxygen failed with return code {}'.format(doxygen_ret))
        sys.exit(doxygen_ret)

    # Generate SWIG code.
    swig_ret = subprocess.call('swig -python -doxygen -I{}/include \
            -outdir {}/fastdds_python/src/swig -c++ -interface \
            _fastdds_python -o \
            {}/fastdds_python/src/swig/fastddsPYTHON_wrap.cxx \
            {}/fastdds_python/src/swig/fastdds.i'.format(
                fastdds_repo_name,
                fastdds_python_repo_name,
                fastdds_python_repo_name,
                fastdds_python_repo_name
                ), shell=True)
    if swig_ret != 0:
        print('SWIG failed with return code {}'.format(swig_ret))
        sys.exit(swig_ret)

    fastdds_python_imported_location = '{}/fastdds_python/src/swig'.format(
            fastdds_python_repo_name)
    autodoc_mock_imports = ["_fastdds_python"]


breathe_projects = {
    'FastDDS': os.path.abspath('{}/xml'.format(output_dir))
}
breathe_default_project = 'FastDDS'
breathe_show_define_initializer = True

# Tell `autodoc` where is the Pydoc documentation if it was set.
if fastdds_python_imported_location:
    sys.path.insert(0, fastdds_python_imported_location)

# -- 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 = [
    'breathe',
    'sphinxcontrib.plantuml',
    'sphinx.ext.autodoc',  # Document Pydoc documentation from Python bindings.
    'sphinx_tabs.tabs'
]

sphinx_tabs_disable_css_loading = False
sphinx_tabs_disable_tab_closing = True

try:
    import sphinxcontrib.spelling  # noqa: F401
    extensions.append('sphinxcontrib.spelling')

    # spelling_word_list_filename = 'spelling_wordlist.txt'
    spelling_word_list_filename = [
        'spelling_wordlist.txt',
        'fastdds/api_reference/spelling_wordlist.txt'
    ]

    from sphinxcontrib.spelling.filters import ContractionFilter
    spelling_filters = [ContractionFilter]
    spelling_ignore_contributor_names = False
    spelling_verbose = True
except ImportError:
    pass

# Default behaviour for `autodoc`: always show documented members.
autodoc_default_options = {
        'members': True,
        'undoc-members': False,
        }

plantuml = '/usr/bin/plantuml -Djava.awt.headless=true '
plantuml_output_format = "svg"

# 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 encoding of source files.
#
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'Fast DDS'
copyright = u'2019, eProsima'
author = u'eProsima'

# 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.
#
# The short X.Y version.
version = u'3.0.0'
# The full version, including alpha/beta/rc tags.
release = u'3.0.0'

# 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 = 'en'

# 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.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = [
    '*/includes/*.rst',
    '*/*/includes/*.rst',
    '*/*/*/includes/*.rst',
    '*/*/*/*/includes/*.rst'
]

# 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

suppress_warnings = [
    'cpp.duplicate_declaration',
    'cpp.parse_function_declaration'
]

# Check if we are checking the spelling. In this case...
if 'spelling' in sys.argv or 'skip_python=' in sys.argv:
    # Exclude Python API Reference because `autodoc` shows warnings.
    exclude_patterns.append('fastdds/python_api_reference/dds_pim/*')
    # Avoid the warning of a wrong reference in the TOC entries,
    # because fails the Python API Reference reference.
    suppress_warnings.append('toc.excluded')

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = 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.
# "<project> v<release> documentation" by default.
#
# html_title = u'sphynx-demo v0.0.1'

# 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 (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
# html_favicon = None

# 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']

html_context = {
        'css_files': select_css(script_path),
        }


# 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 None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
# html_last_updated_fmt = None

# 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

# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
#
# html_search_language = 'en'

# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#
# html_search_options = {'type': 'default'}

# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#
# html_search_scorer = 'scorer.js'

# Output file base name for HTML help builder.
htmlhelp_basename = 'FastDDSManual'

# -- 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, 'FastDDS.tex', u'Fast DDS Documentation',
     u'eProsima', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
# latex_logo = 01-figures/logo.png

# 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 = []

# It false, will not define \strong, \code, 	itleref, \crossref ... but only
# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
# packages.
#
# latex_keep_old_macro_names = True

# 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 = [
    (master_doc, 'Fast DDS', u'Fast DDS Documentation',
     [author], 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 = [
    (master_doc, 'Fast DDS', u'Fast DDS Documentation',
     author, 'Fast DDS', 'Documentation of eProsima Fast DDS',
     '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