manarabdelaty | a1553af | 2021-05-07 19:47:19 +0200 | [diff] [blame] | 1 | # SPDX-FileCopyrightText: 2020 Efabless Corporation |
| 2 | # |
| 3 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | # you may not use this file except in compliance with the License. |
| 5 | # You may obtain a copy of the License at |
| 6 | # |
| 7 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | # |
| 9 | # Unless required by applicable law or agreed to in writing, software |
| 10 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | # See the License for the specific language governing permissions and |
| 13 | # limitations under the License. |
| 14 | # |
| 15 | # SPDX-License-Identifier: Apache-2.0 |
| 16 | |
| 17 | # Configuration file for the Sphinx documentation builder. |
| 18 | # |
| 19 | # This file only contains a selection of the most common options. For a full |
| 20 | # list see the documentation: |
| 21 | # https://www.sphinx-doc.org/en/master/usage/configuration.html |
| 22 | |
| 23 | # -- Path setup -------------------------------------------------------------- |
| 24 | |
| 25 | # If extensions (or modules to document with autodoc) are in another directory, |
| 26 | # add these directories to sys.path here. If the directory is relative to the |
| 27 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
| 28 | # |
| 29 | # import os |
| 30 | # import sys |
| 31 | # sys.path.insert(0, os.path.abspath('.')) |
| 32 | |
| 33 | |
| 34 | # -- Project information ----------------------------------------------------- |
| 35 | |
| 36 | project = 'CIIC Harness' |
| 37 | copyright = '2020, efabless' |
| 38 | author = 'efabless' |
| 39 | |
| 40 | |
| 41 | # -- General configuration --------------------------------------------------- |
| 42 | |
| 43 | # Add any Sphinx extension module names here, as strings. They can be |
| 44 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 45 | # ones. |
| 46 | extensions = [ |
| 47 | 'sphinxcontrib.wavedrom', |
| 48 | 'sphinx.ext.mathjax', |
| 49 | 'sphinx.ext.todo' |
| 50 | ] |
| 51 | |
| 52 | # Add any paths that contain templates here, relative to this directory. |
| 53 | templates_path = ['_templates'] |
| 54 | |
| 55 | # List of patterns, relative to source directory, that match files and |
| 56 | # directories to ignore when looking for source files. |
| 57 | # This pattern also affects html_static_path and html_extra_path. |
| 58 | exclude_patterns = [ |
| 59 | 'build', |
| 60 | 'Thumbs.db', |
| 61 | # Files included in other rst files. |
| 62 | 'introduction.rst', |
| 63 | ] |
| 64 | |
| 65 | |
| 66 | # -- Options for HTML output ------------------------------------------------- |
| 67 | """ |
| 68 | html_theme_options = { |
| 69 | 'header_links' : [ |
| 70 | ("Home", 'index', False, 'home'), |
| 71 | ("GitHub", "https://github.com/efabless/caravel", True, 'code'), |
| 72 | ], |
| 73 | 'hide_symbiflow_links': True, |
| 74 | 'license_url' : 'https://www.apache.org/licenses/LICENSE-2.0', |
| 75 | } |
| 76 | """ |
| 77 | # The theme to use for HTML and HTML Help pages. See the documentation for |
| 78 | # a list of builtin themes. |
| 79 | # |
| 80 | html_theme = 'sphinx_rtd_theme' |
| 81 | |
| 82 | # Add any paths that contain custom static files (such as style sheets) here, |
| 83 | # relative to this directory. They are copied after the builtin static files, |
| 84 | # so a file named "default.css" will overwrite the builtin "default.css". |
| 85 | html_static_path = ['_static'] |
| 86 | |
| 87 | todo_include_todos = False |
| 88 | |
| 89 | numfig = True |