conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Configuration file for the Sphinx documentation builder.
   4 #
   5 # This file does only contain a selection of the most common options. For a
   6 # full list see the documentation:
   7 # http://www.sphinx-doc.org/en/master/config
   8
   9 # -- Path setup --------------------------------------------------------------
  10
  11 # If extensions (or modules to document with autodoc) are in another directory,
  12 # add these directories to sys.path here. If the directory is relative to the
  13 # documentation root, use os.path.abspath to make it absolute, like shown here.
  14 #
  15 import os
  16 import sys
  17 sys.path.insert(0, os.path.abspath('.'))
  18 import recommonmark
  19 from recommonmark.transform import AutoStructify
  20
  21
  22 # -- Project information -----------------------------------------------------
  23
  24 project = 'ieee754fpu'
  25 copyright = '2021, lkcl@libre-soc.org and Libre-SOC Team'
  26 author = 'lkcl@libre-soc.org'
  27
  28 # The short X.Y version
  29 version = ''
  30 # The full version, including alpha/beta/rc tags
  31 release = ''
  32
  33
  34 # -- General configuration ---------------------------------------------------
  35
  36 # If your documentation needs a minimal Sphinx version, state it here.
  37 #
  38 # needs_sphinx = '1.0'
  39
  40 # Add any Sphinx extension module names here, as strings. They can be
  41 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  42 # ones.
  43 extensions = [
  44     'sphinx.ext.autodoc',
  45     'sphinx.ext.intersphinx',
  46     'sphinx.ext.todo',
  47     'sphinx.ext.coverage',
  48     'sphinx_rtd_theme',
  49     'recommonmark',
  50 ]
  51
  52 # Add any paths that contain templates here, relative to this directory.
  53 templates_path = ['html/_templates']
  54
  55 from recommonmark.parser import CommonMarkParser
  56
  57 source_parsers = {
  58         '.txt': CommonMarkParser,
  59 }
  60
  61 # The suffix(es) of source filenames.
  62 # You can specify multiple suffix as a list of string:
  63 #
  64 # source_suffix = ['.rst', '.md']
  65 source_suffix = ['.rst', '.md', '.txt']
  66
  67 # The master toctree document.
  68 master_doc = 'index'
  69
  70 # The language for content autogenerated by Sphinx. Refer to documentation
  71 # for a list of supported languages.
  72 #
  73 # This is also used if you do content translation via gettext catalogs.
  74 # Usually you set "language" from the command line for these cases.
  75 language = None
  76
  77 # List of patterns, relative to source directory, that match files and
  78 # directories to ignore when looking for source files.
  79 # This pattern also affects html_static_path and html_extra_path.
  80 exclude_patterns = ['build']
  81
  82 # The name of the Pygments (syntax highlighting) style to use.
  83 pygments_style = 'sphinx'
  84
  85
  86 # -- Options for HTML output -------------------------------------------------
  87
  88 # The theme to use for HTML and HTML Help pages.  See the documentation for
  89 # a list of builtin themes.
  90 #
  91 html_theme = 'sphinx_rtd_theme'
  92
  93 # Theme options are theme-specific and customize the look and feel of a theme
  94 # further.  For a list of options available for each theme, see the
  95 # documentation.
  96 #
  97 # html_theme_options = {}
  98
  99 # Add any paths that contain custom static files (such as style sheets) here,
 100 # relative to this directory. They are copied after the builtin static files,
 101 # so a file named "default.css" will overwrite the builtin "default.css".
 102 html_static_path = ['html/_static']
 103
 104 # Custom sidebar templates, must be a dictionary that maps document names
 105 # to template names.
 106 #
 107 # The default sidebars (for documents that don't match any pattern) are
 108 # defined by theme itself.  Builtin themes are using these templates by
 109 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 110 # 'searchbox.html']``.
 111 #
 112 # html_sidebars = {}
 113
 114
 115 # -- Options for HTMLHelp output ---------------------------------------------
 116
 117 # Output file base name for HTML help builder.
 118 htmlhelp_basename = 'ieee754fpudoc'
 119
 120
 121 # -- Options for LaTeX output ------------------------------------------------
 122
 123 latex_elements = {
 124     # The paper size ('letterpaper' or 'a4paper').
 125     #
 126     # 'papersize': 'letterpaper',
 127
 128     # The font size ('10pt', '11pt' or '12pt').
 129     #
 130     # 'pointsize': '10pt',
 131
 132     # Additional stuff for the LaTeX preamble.
 133     #
 134     # 'preamble': '',
 135
 136     # Latex figure (float) alignment
 137     #
 138     # 'figure_align': 'htbp',
 139 }
 140
 141 # Grouping the document tree into LaTeX files. List of tuples
 142 # (source start file, target name, title,
 143 #  author, documentclass [howto, manual, or own class]).
 144 latex_documents = [
 145     (master_doc, 'ieee754fpu.tex', 'ieee754fpu Documentation',
 146      'lkcl@libre-soc.org', '1'),
 147 ]
 148
 149
 150 # -- Options for manual page output ------------------------------------------
 151
 152 # One entry per manual page. List of tuples
 153 # (source start file, name, description, authors, manual section).
 154 man_pages = [
 155     (master_doc, 'ieee754fpu', 'ieee754fpu Documentation',
 156      [author], 1)
 157 ]
 158
 159
 160 # -- Options for Texinfo output ----------------------------------------------
 161
 162 # Grouping the document tree into Texinfo files. List of tuples
 163 # (source start file, target name, title, author,
 164 #  dir menu entry, description, category)
 165 texinfo_documents = [
 166     (master_doc, 'ieee754fpu', 'ieee754fpu Documentation',
 167      author, 'ieee754fpu', 'One line description of project.',
 168      'Miscellaneous'),
 169 ]
 170
 171
 172 # -- Extension configuration -------------------------------------------------
 173
 174 # -- Options for intersphinx extension ---------------------------------------
 175
 176 lsocbase = 'https://docs.libre-soc.org/'
 177 # Example configuration for intersphinx: refer to the Python standard library.
 178 intersphinx_mapping = {"python": ('https://docs.python.org/3', None),
 179                        "nmigen": ('https://nmigen.info/nmigen/latest', None),
 180                        "openpower": (lsocbase+'openpower-isa', None),
 181                        "soc": (lsocbase+'soc', None),
 182 }
 183
 184 # -- Options for todo extension ----------------------------------------------
 185
 186 # If true, `todo` and `todoList` produce output, else they produce nothing.
 187 todo_include_todos = True
 188
 189 # app setup hook
 190 def setup(app):
 191     app.add_config_value('recommonmark_config', {
 192         #'url_resolver': lambda url: github_doc_root + url,
 193         'auto_toc_tree_section': 'Contents',
 194         'enable_math': False,
 195         'enable_inline_math': False,
 196         'enable_eval_rst': True,
 197         'enable_auto_doc_ref': True,
 198     }, True)
 199     app.add_transform(AutoStructify)