diff --git a/doc/conf.py b/doc/conf.py index d60d44a00..ed6a223f3 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -276,6 +276,7 @@ def minidom_parse_with_fixup(inFilename, *args, **kw): breathe_projects = { "firmware": "_doxygen/firmware/xml", + "gateware": "_doxygen/gateware/xml", "edid-decode": "_doxygen/edid-decode/xml", "libuip": "_doxygen/libuip/xml", @@ -292,6 +293,7 @@ def minidom_parse_with_fixup(inFilename, *args, **kw): breathe_projects_source = { "firmware": "../firmware", + "gateware": "../gateware", "edid-decode": "../third_party/edid-decode", "libuip": "../third_party/libuip", @@ -324,6 +326,9 @@ def minidom_parse_with_fixup(inFilename, *args, **kw): #"exhaleUseDoxyfile": True, "exhaleDoxygenStdin": """ EXCLUDE = ../doc ../third_party/litex/litex/soc/software/compiler_rt ../third_party/litex/litex/soc/software/libcompiler_rt */__pycache__ + +OPTIMIZE_OUTPUT_VERILOG = YES +HIDE_PORT = NO """, } @@ -335,6 +340,11 @@ def minidom_parse_with_fixup(inFilename, *args, **kw): "containmentFolder": "firmware-api", "rootFileTitle": "Firmware", }, + "gateware": { + "exhaleDoxygenStdin": "INPUT = ../gateware"+exhale_args["exhaleDoxygenStdin"], + "containmentFolder": "gateware-api", + "rootFileTitle": "Gateware", + }, # Third Party Project Includes "edid-decode": { "exhaleDoxygenStdin": "INPUT = ../third_party/edid-decode"+exhale_args["exhaleDoxygenStdin"], diff --git a/doc/requirements.txt b/doc/requirements.txt index 0b8ccc2fa..871d5c1ab 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -3,10 +3,10 @@ sphinx==1.7.0 sphinx-autobuild # Important core Sphinx extensions -sphinx_rtd_theme -recommonmark breathe exhale +recommonmark +sphinx_rtd_theme sphinxcontrib-napoleon -e hg+https://mithro@bitbucket.org/mithro/sphinxcontrib-domaintools@mithro/use-dictitems-instead-of-dictiteritems-f-1519177628123#egg=sphinxcontrib-domaintools