git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/RISC-V_RV32_SiFive_HiFive1_GCC/freedom-metal/doc/sphinx/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
  19
  20 # -- Project information -----------------------------------------------------
  21
  22 project = 'Freedom Metal'
  23 copyright = '2019, SiFive Inc.'
  24 author = 'SiFive Inc.'
  25
  26 version = "v201905"
  27 release = version
  28
  29
  30 # -- General configuration ---------------------------------------------------
  31
  32 # If your documentation needs a minimal Sphinx version, state it here.
  33 #
  34 # needs_sphinx = '1.0'
  35
  36 # Add any Sphinx extension module names here, as strings. They can be
  37 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  38 # ones.
  39 extensions = [
  40         "breathe",
  41         "sphinx.ext.graphviz"
  42 ]
  43
  44 breathe_projects = {
  45         "metal" : "../xml/",
  46 }
  47
  48 # Add any paths that contain templates here, relative to this directory.
  49 templates_path = ['metal_templates']
  50
  51 # The suffix(es) of source filenames.
  52 # You can specify multiple suffix as a list of string:
  53 #
  54 # source_suffix = ['.rst', '.md']
  55 source_suffix = '.rst'
  56
  57 # The master toctree document.
  58 master_doc = 'index'
  59
  60 # The language for content autogenerated by Sphinx. Refer to documentation
  61 # for a list of supported languages.
  62 #
  63 # This is also used if you do content translation via gettext catalogs.
  64 # Usually you set "language" from the command line for these cases.
  65 language = None
  66
  67 # List of patterns, relative to source directory, that match files and
  68 # directories to ignore when looking for source files.
  69 # This pattern also affects html_static_path and html_extra_path .
  70 exclude_patterns = []
  71
  72 # The name of the Pygments (syntax highlighting) style to use.
  73 pygments_style = 'sphinx'
  74
  75
  76 # -- Options for HTML output -------------------------------------------------
  77
  78 # The theme to use for HTML and HTML Help pages.  See the documentation for
  79 # a list of builtin themes.
  80 #
  81 html_theme = 'alabaster'
  82
  83 # Theme options are theme-specific and customize the look and feel of a theme
  84 # further.  For a list of options available for each theme, see the
  85 # documentation.
  86 #
  87 # html_theme_options = {}
  88
  89 # Add any paths that contain custom static files (such as style sheets) here,
  90 # relative to this directory. They are copied after the builtin static files,
  91 # so a file named "default.css" will overwrite the builtin "default.css".
  92 html_static_path = ['metal_static']
  93
  94 # Custom sidebar templates, must be a dictionary that maps document names
  95 # to template names.
  96 #
  97 # The default sidebars (for documents that don't match any pattern) are
  98 # defined by theme itself.  Builtin themes are using these templates by
  99 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 100 # 'searchbox.html']``.
 101 #
 102 # html_sidebars = {}
 103 html_sidebars = { '**': ['about.html', 'navigation.html', 'relations.html', 'searchbox.html']}
 104
 105
 106 # -- Options for HTMLHelp output ---------------------------------------------
 107
 108 # Output file base name for HTML help builder.
 109 htmlhelp_basename = 'FreedomMetaldoc'
 110
 111
 112 # -- Options for LaTeX output ------------------------------------------------
 113
 114 latex_elements = {
 115     # The paper size ('letterpaper' or 'a4paper').
 116     #
 117     # 'papersize': 'letterpaper',
 118
 119     # The font size ('10pt', '11pt' or '12pt').
 120     #
 121     # 'pointsize': '10pt',
 122
 123     # Additional stuff for the LaTeX preamble.
 124     #
 125     # 'preamble': '',
 126
 127     # Latex figure (float) alignment
 128     #
 129     # 'figure_align': 'htbp',
 130 }
 131
 132 # Grouping the document tree into LaTeX files. List of tuples
 133 # (source start file, target name, title,
 134 #  author, documentclass [howto, manual, or own class]).
 135 latex_documents = [
 136     (master_doc, 'FreedomMetal.tex', 'Freedom Metal Documentation',
 137      'SiFive Inc.', 'manual'),
 138 ]
 139
 140
 141 # -- Options for manual page output ------------------------------------------
 142
 143 # One entry per manual page. List of tuples
 144 # (source start file, name, description, authors, manual section).
 145 man_pages = [
 146     (master_doc, 'freedommetal', 'Freedom Metal Documentation',
 147      [author], 1)
 148 ]
 149
 150
 151 # -- Options for Texinfo output ----------------------------------------------
 152
 153 # Grouping the document tree into Texinfo files. List of tuples
 154 # (source start file, target name, title, author,
 155 #  dir menu entry, description, category)
 156 texinfo_documents = [
 157     (master_doc, 'FreedomMetal', 'Freedom Metal Documentation',
 158      author, 'FreedomMetal', 'One line description of project.',
 159      'Miscellaneous'),
 160 ]