2018-09-13 16:38:41 -05:00
|
|
|
# -*- 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.
|
|
|
|
#
|
2018-09-13 16:52:08 -05:00
|
|
|
import sys
|
|
|
|
import os
|
|
|
|
import shlex
|
2018-09-13 16:38:41 -05:00
|
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
|
2018-09-13 16:52:08 -05:00
|
|
|
import sphinx_rtd_theme
|
2018-09-13 16:48:10 -05:00
|
|
|
|
2019-09-02 03:45:05 -05:00
|
|
|
# Uncomment for local build
|
2018-09-14 00:00:56 -05:00
|
|
|
#html_theme = "sphinx_rtd_theme"
|
|
|
|
#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
2018-09-13 16:48:10 -05:00
|
|
|
|
2021-02-07 17:17:54 -06:00
|
|
|
# For bibtex support
|
|
|
|
import sphinxcontrib.bibtex
|
|
|
|
# For embedded youtube
|
|
|
|
import sphinxcontrib.yt
|
2021-02-07 18:53:58 -06:00
|
|
|
# For converting SVG to PNG using inkscape
|
|
|
|
import sphinxcontrib.inkscapeconverter
|
2021-02-06 20:45:41 -06:00
|
|
|
|
2018-09-13 16:38:41 -05:00
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
|
|
|
|
project = u'OpenFPGA'
|
|
|
|
copyright = u'2018, Xifan Tang'
|
|
|
|
author = u'Xifan Tang'
|
|
|
|
|
|
|
|
# The short X.Y version
|
|
|
|
version = u''
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
|
|
release = u'1.0'
|
|
|
|
|
|
|
|
|
|
|
|
# -- 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 = [
|
2018-09-14 14:11:51 -05:00
|
|
|
'sphinx.ext.todo',
|
|
|
|
'sphinx.ext.mathjax',
|
|
|
|
'sphinx.ext.graphviz',
|
2019-09-02 03:45:05 -05:00
|
|
|
'sphinxcontrib.bibtex',
|
|
|
|
'sphinx.ext.autosectionlabel',
|
2021-02-06 20:45:41 -06:00
|
|
|
'sphinxcontrib.yt',
|
2021-02-07 18:53:58 -06:00
|
|
|
'sphinxcontrib.inkscapeconverter',
|
2018-09-13 16:38:41 -05:00
|
|
|
]
|
|
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
2018-09-13 18:59:53 -05:00
|
|
|
#templates_path = ['ytemplates']
|
2018-09-14 14:11:51 -05:00
|
|
|
templates_path = [sphinx_rtd_theme.get_html_theme_path()]
|
2018-09-13 16:38:41 -05:00
|
|
|
|
|
|
|
# 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.
|
2018-09-13 18:59:53 -05:00
|
|
|
pygments_style = 'sphinx'
|
|
|
|
|
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
|
|
todo_include_todos = True
|
|
|
|
|
2019-09-02 03:45:05 -05:00
|
|
|
# Number figures for referencing
|
2018-09-13 18:59:53 -05:00
|
|
|
numfig = True
|
2018-09-13 16:38:41 -05:00
|
|
|
|
|
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
|
|
# a list of builtin themes.
|
|
|
|
#
|
2018-09-13 18:59:53 -05:00
|
|
|
#html_theme = 'alabaster'
|
2018-09-14 14:11:51 -05:00
|
|
|
html_theme = 'sphinx_rtd_theme'
|
2018-09-13 16:38:41 -05: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.
|
|
|
|
#
|
2018-09-14 00:00:56 -05:00
|
|
|
# Comment when using local build
|
|
|
|
# Uncomment when using readthedocs build
|
2018-09-14 14:11:51 -05:00
|
|
|
#html_theme_options = {sphinx_rtd_theme}
|
2018-09-13 16:38:41 -05:00
|
|
|
|
|
|
|
# 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".
|
2018-09-13 18:59:53 -05:00
|
|
|
#html_static_path = ['ystatic']
|
2018-09-13 16:38:41 -05:00
|
|
|
|
|
|
|
# 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 = 'OpenFPGAdoc'
|
|
|
|
|
|
|
|
|
|
|
|
# -- 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, 'OpenFPGA.tex', u'OpenFPGA Documentation',
|
|
|
|
u'Xifan Tang', '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, 'openfpga', u'OpenFPGA 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, 'OpenFPGA', u'OpenFPGA Documentation',
|
|
|
|
author, 'OpenFPGA', '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.
|
2018-09-13 16:48:10 -05:00
|
|
|
epub_exclude_files = ['search.html']
|