e146f1b2bc
This PR adds documentation to the standard library using Sphinx. For details on how the documentation was generated, refer to https://gem5.atlassian.net/browse/GEM5-1314. Currently, some modules like `dramsys` and `mesi_three_level` appear as blank pages. To view the current state of the documentation locally, run: `cd docs/_build/html; python3 -m http.server 8000` --------- Co-authored-by: ivanaamit <ivanamit91@gmail.com>
43 lines
1.3 KiB
Python
43 lines
1.3 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# For the full list of built-in configuration values, see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = "gem5"
|
|
copyright = ""
|
|
author = ""
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx.ext.todo",
|
|
]
|
|
|
|
templates_path = ["_templates"]
|
|
exclude_patterns = [
|
|
"_build",
|
|
"Thumbs.db",
|
|
".DS_Store",
|
|
"build/lib64/python3.8/site-packages",
|
|
"build/lib/python3.8/site-packages",
|
|
]
|
|
|
|
language = "en"
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = "alabaster"
|
|
html_static_path = ["_static"]
|
|
|
|
# -- Options for todo extension ----------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration
|
|
|
|
todo_include_todos = True
|