litex: add `sphinx_extra_config` to `generate_docs()`
authorSean Cross <sean@xobs.io>
Fri, 24 Jul 2020 08:01:54 +0000 (16:01 +0800)
committerSean Cross <sean@xobs.io>
Fri, 24 Jul 2020 08:01:54 +0000 (16:01 +0800)
This allows us to append additional strings to the sphinx `conf.py`.

Signed-off-by: Sean Cross <sean@xobs.io>
litex/soc/doc/__init__.py

index fe2f479fdd83a8fd7f45144d92269dd50a9fd85d..00097b5cc49c776eb48889fe7ab83711ae936992 100644 (file)
@@ -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))