Skip to content

Commit

Permalink
docs: Adding missing gateware subproject.
Browse files Browse the repository at this point in the history
  • Loading branch information
mithro committed Aug 31, 2018
1 parent b34ffef commit 6ca3e95
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
10 changes: 10 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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
""",
}

Expand All @@ -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"],
Expand Down
4 changes: 2 additions & 2 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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://[email protected]/mithro/sphinxcontrib-domaintools@mithro/use-dictitems-instead-of-dictiteritems-f-1519177628123#egg=sphinxcontrib-domaintools
Expand Down

0 comments on commit 6ca3e95

Please sign in to comment.