Skip to content

Commit 87f3d8e

Browse files
committedSep 10, 2018
docs: Adding missing gateware subproject.
1 parent c215e3d commit 87f3d8e

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed
 

‎doc/conf.py

+10
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,7 @@ def minidom_parse_with_fixup(inFilename, *args, **kw):
276276

277277
breathe_projects = {
278278
"firmware": "_doxygen/firmware/xml",
279+
"gateware": "_doxygen/gateware/xml",
279280

280281
"edid-decode": "_doxygen/edid-decode/xml",
281282
"libuip": "_doxygen/libuip/xml",
@@ -292,6 +293,7 @@ def minidom_parse_with_fixup(inFilename, *args, **kw):
292293

293294
breathe_projects_source = {
294295
"firmware": "../firmware",
296+
"gateware": "../gateware",
295297

296298
"edid-decode": "../third_party/edid-decode",
297299
"libuip": "../third_party/libuip",
@@ -324,6 +326,9 @@ def minidom_parse_with_fixup(inFilename, *args, **kw):
324326
#"exhaleUseDoxyfile": True,
325327
"exhaleDoxygenStdin": """
326328
EXCLUDE = ../doc ../third_party/litex/litex/soc/software/compiler_rt ../third_party/litex/litex/soc/software/libcompiler_rt */__pycache__
329+
330+
OPTIMIZE_OUTPUT_VERILOG = YES
331+
HIDE_PORT = NO
327332
""",
328333
}
329334

@@ -335,6 +340,11 @@ def minidom_parse_with_fixup(inFilename, *args, **kw):
335340
"containmentFolder": "firmware-api",
336341
"rootFileTitle": "Firmware",
337342
},
343+
"gateware": {
344+
"exhaleDoxygenStdin": "INPUT = ../gateware"+exhale_args["exhaleDoxygenStdin"],
345+
"containmentFolder": "gateware-api",
346+
"rootFileTitle": "Gateware",
347+
},
338348
# Third Party Project Includes
339349
"edid-decode": {
340350
"exhaleDoxygenStdin": "INPUT = ../third_party/edid-decode"+exhale_args["exhaleDoxygenStdin"],

‎doc/requirements.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ sphinx==1.7.0
33
sphinx-autobuild
44

55
# Important core Sphinx extensions
6-
sphinx_rtd_theme
7-
recommonmark
86
breathe
97
exhale
8+
recommonmark
9+
sphinx_rtd_theme
1010
sphinxcontrib-napoleon
1111

1212
-e hg+https://mithro@bitbucket.org/mithro/sphinxcontrib-domaintools@mithro/use-dictitems-instead-of-dictiteritems-f-1519177628123#egg=sphinxcontrib-domaintools

0 commit comments

Comments
 (0)