From: Sean Cross <sean@xobs.io>
Date: Fri, 24 Jul 2020 08:01:54 +0000 (+0800)
Subject: litex: add `sphinx_extra_config` to `generate_docs()`
X-Git-Tag: 24jan2021_ls180~58^2~1
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=dd366467ed5fd949d6ed1cf92ccfbc60e9b4def7;p=litex.git

litex: add `sphinx_extra_config` to `generate_docs()`

This allows us to append additional strings to the sphinx `conf.py`.

Signed-off-by: Sean Cross <sean@xobs.io>
---

diff --git a/litex/soc/doc/__init__.py b/litex/soc/doc/__init__.py
index fe2f479f..00097b5c 100644
--- a/litex/soc/doc/__init__.py
+++ b/litex/soc/doc/__init__.py
@@ -36,12 +36,13 @@ def generate_svd(soc, buildpath, filename=None, name="soc", **kwargs):
 
 
 def generate_docs(soc, base_dir,
-    project_name      = "LiteX SoC Project",
-    author            = "Anonymous",
-    sphinx_extensions = [],
-    quiet             = False,
-    note_pulses       = False,
-    from_scratch      = True):
+    project_name          = "LiteX SoC Project",
+    author                = "Anonymous",
+    sphinx_extensions     = [],
+    quiet                 = False,
+    note_pulses           = False,
+    from_scratch          = True,
+    sphinx_extra_config   = ""):
     """Possible extra extensions:
         [
             'm2r',
@@ -68,6 +69,7 @@ def generate_docs(soc, base_dir,
                 sphinx_ext_str += "\n    \"{}\",".format(ext)
             print(default_sphinx_configuration.format(project_name, year,
                                                       author, author, sphinx_ext_str), file=conf)
+            print(sphinx_extra_config, file=conf)
 
     if not quiet:
         print("Generate the documentation by running `sphinx-build -M html {} {}_build`".format(base_dir, base_dir))