diff --git a/tracetools_test/docs/.gitignore b/tracetools_test/docs/.gitignore new file mode 100644 index 0000000..567609b --- /dev/null +++ b/tracetools_test/docs/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/tracetools_test/docs/Makefile b/tracetools_test/docs/Makefile new file mode 100644 index 0000000..69fe55e --- /dev/null +++ b/tracetools_test/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/tracetools_test/docs/source/about.rst b/tracetools_test/docs/source/about.rst new file mode 100644 index 0000000..e9f97ab --- /dev/null +++ b/tracetools_test/docs/source/about.rst @@ -0,0 +1,4 @@ +About +===== + +Testing utilities and tests for the `tracetools package `_. diff --git a/tracetools_test/docs/source/api.rst b/tracetools_test/docs/source/api.rst new file mode 100644 index 0000000..1ff35bc --- /dev/null +++ b/tracetools_test/docs/source/api.rst @@ -0,0 +1,8 @@ +API +=== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + api/trace_test_case diff --git a/tracetools_test/docs/source/api/trace_test_case.rst b/tracetools_test/docs/source/api/trace_test_case.rst new file mode 100644 index 0000000..ac37bd6 --- /dev/null +++ b/tracetools_test/docs/source/api/trace_test_case.rst @@ -0,0 +1,4 @@ +TraceTestCase +============= + +.. automodule:: tracetools_test.case diff --git a/tracetools_test/docs/source/conf.py b/tracetools_test/docs/source/conf.py new file mode 100644 index 0000000..e99e1ee --- /dev/null +++ b/tracetools_test/docs/source/conf.py @@ -0,0 +1,218 @@ +# Copyright 2019 Open Source Robotics Foundation, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- 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 +# tracetools_test +sys.path.insert(0, os.path.abspath('../../')) +# # tracetools_launch +# sys.path.insert(0, os.path.abspath('../../../tracetools_launch/')) +# # tracetools_read +# sys.path.insert(0, os.path.abspath('../../../tracetools_read/')) +# # tracetools_trace +# sys.path.insert(0, os.path.abspath('../../../tracetools_trace/')) + + +# -- Project information ----------------------------------------------------- + +project = 'tracetools_test' +copyright = '2019, Robert Bosch GmbH' # noqa +author = 'Robert Bosch GmbH' + +# The short X.Y version +version = os.environ.get('SPHINX_VERSION_SHORT', '') +# The full version, including alpha/beta/rc tags +release = os.environ.get('SPHINX_VERSION_FULL', '') + + +# -- 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.ext.autodoc', + 'sphinx_autodoc_typehints', + 'sphinx.ext.autosummary', + 'sphinx.ext.doctest', + 'sphinx.ext.coverage', +] + +# 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 = 'alabaster' + +# 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 = [] + +# 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 = 'tracetools_test-doc' + + +# -- 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, 'rclpy.tex', 'rclpy Documentation', +# 'Esteve Fernandez', '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, 'rclpy', 'rclpy 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, 'rclpy', 'rclpy Documentation', +# author, 'rclpy', '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 ------------------------------------------------- + +# Ignore these +autodoc_mock_imports = [ + 'tracetools_launch', + 'tracetools_read', + 'tracetools_trace', + 'launch', + 'launch_ros', +] + +autoclass_content = 'both' + +autodoc_default_options = { + 'members': None, + 'undoc-members': True, +} diff --git a/tracetools_test/docs/source/index.rst b/tracetools_test/docs/source/index.rst new file mode 100644 index 0000000..f149a5e --- /dev/null +++ b/tracetools_test/docs/source/index.rst @@ -0,0 +1,17 @@ +tracetools_test +=============== + +tracetools_test provides testing utilities and tests for the `tracetools package `_. + +.. toctree:: + :maxdepth: 3 + + about + api + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`