artiq/doc/manual/conf.py

309 lines
9.6 KiB
Python
Raw Normal View History

2014-09-18 17:45:54 +08:00
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# ARTIQ documentation build configuration file, created by
# sphinx-quickstart on Thu Sep 18 16:51:53 2014.
#
# 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 sys
import os
from unittest.mock import Mock
2014-09-18 17:45:54 +08:00
2016-08-26 03:52:46 +08:00
import sphinx_rtd_theme
# Hack-patch Sphinx so that ARTIQ-Python types are correctly printed
# See: https://github.com/m-labs/artiq/issues/741
from sphinx.ext import autodoc
from sphinx.util import inspect
autodoc.repr = inspect.repr = str
# we cannot use autodoc_mock_imports (does not help with argparse)
mock_modules = ["artiq.gui.waitingspinnerwidget",
2017-01-27 00:54:10 +08:00
"artiq.gui.flowlayout",
"artiq.compiler.module",
"artiq.compiler.embedding",
2017-01-27 00:54:10 +08:00
"quamash", "pyqtgraph", "matplotlib",
"numpy", "dateutil", "dateutil.parser", "prettytable", "PyQt5",
2019-04-20 10:51:29 +08:00
"h5py", "serial", "scipy", "scipy.interpolate",
2019-11-18 08:37:44 +08:00
"llvmlite_artiq", "Levenshtein", "pythonparser", "sipyco"]
for module in mock_modules:
sys.modules[module] = Mock()
# https://stackoverflow.com/questions/29992444/sphinx-autodoc-skips-classes-inherited-from-mock
class MockApplets:
class AppletsDock:
pass
sys.modules["artiq.gui.applets"] = MockApplets
2014-09-18 17:45:54 +08:00
# 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.
2017-01-27 00:56:18 +08:00
sys.path.insert(0, os.path.abspath('../..'))
2016-01-20 09:25:31 +08:00
2016-01-26 05:10:24 +08:00
from artiq import __version__ as artiq_version
2014-09-18 17:45:54 +08:00
# -- 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.ext.mathjax',
2016-05-28 01:01:14 +08:00
'sphinx.ext.viewcode',
2017-01-26 06:25:01 +08:00
'sphinx.ext.napoleon',
2015-01-23 00:52:13 +08:00
'sphinxarg.ext',
2016-08-25 18:56:36 +08:00
'sphinxcontrib.wavedrom', # see also below for config
2014-09-18 17:45:54 +08:00
]
mathjax_path = "https://m-labs.hk/MathJax/MathJax.js?config=TeX-AMS-MML_HTMLorMML.js"
2014-09-18 17:45:54 +08:00
# 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 = 'ARTIQ'
2019-01-03 20:21:34 +08:00
copyright = '2014-2019, M-Labs Limited'
2014-09-18 17:45:54 +08:00
# 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 = artiq_version.split('+', 1)[0]
2014-09-18 17:45:54 +08:00
# The full version, including alpha/beta/rc tags.
2016-01-26 05:10:24 +08:00
release = artiq_version
2014-09-18 17:45:54 +08:00
# 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 = ['_build']
# 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.
2016-08-26 03:52:46 +08:00
html_theme = 'sphinx_rtd_theme'
2014-09-18 17:45:54 +08:00
# 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.
2016-08-26 04:21:29 +08:00
html_theme_options = {}
2014-09-18 17:45:54 +08:00
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
2016-08-26 03:52:46 +08:00
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
2014-09-18 17:45:54 +08:00
# 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.
2016-08-26 03:52:46 +08:00
html_logo = '../logo/artiq_white.png'
2014-09-18 17:45:54 +08:00
# 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
# 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 = 'ARTIQdoc'
# -- 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', 'ARTIQ.tex', 'ARTIQ Documentation',
2019-02-26 16:48:24 +08:00
'M-Labs and contributors', 'manual'),
2014-09-18 17:45:54 +08:00
]
# 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', 'artiq', 'ARTIQ Documentation',
2019-02-26 16:48:24 +08:00
['M-Labs and contributors'], 1)
2014-09-18 17:45:54 +08:00
]
# 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', 'ARTIQ', 'ARTIQ Documentation',
2019-02-26 16:48:24 +08:00
'M-Labs and contributors', 'ARTIQ', 'A leading-edge control system for quantum information experiments.',
2014-09-18 17:45:54 +08:00
'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
2016-08-25 18:56:36 +08:00
# -- Options for sphinxcontrib-wavedrom -----------------------------------
2016-08-26 03:52:46 +08:00
offline_skin_js_path = '_static/default.js'
offline_wavedrom_js_path = '_static/WaveDrom.js'