Adding C documentation generation for libeb-c

docs/.gitignore

@@ -1,3 +1,5 @@
 env
 _build
 _download
+libeb-c-api/
+doxyoutput/

docs/Makefile

@@ -40,3 +40,9 @@ env: _download/Miniconda3-latest-Linux-x86_64.sh
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 .PHONY: Makefile
+
+clean:
+	rm -rf libeb-c/doxyoutput/ libeb-c/api/
+	@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: clean

docs/conf.py

@@ -48,6 +48,8 @@
     'symbolator_sphinx',
     'sphinxcontrib_verilog_diagrams',
     'sphinxcontrib_session',
+    'breathe',
+    'exhale',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -279,3 +281,26 @@
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
+
+# -- Options for breathe / exhale --------------------------------------------
+
+# Setup the breathe extension
+breathe_projects = {
+    "libeb-c": "./doxyoutput/xml"
+}
+breathe_default_project = "libeb-c"
+
+# Setup the exhale extension
+exhale_args = {
+    # These arguments are required
+    "containmentFolder":     "./libeb-c-api",
+    "rootFileName":          "library_root.rst",
+    "rootFileTitle":         "Library API",
+    "doxygenStripFromPath":  "../libeb-c",
+    # Suggested optional arguments
+    "createTreeView":        True,
+    # TIP: if using the sphinx-bootstrap-theme, you need
+    # "treeViewIsBootstrap": True,
+    "exhaleExecutesDoxygen": True,
+    "exhaleDoxygenStdin":    "INPUT = ../libeb-c"
+}

docs/environment.yml

@@ -4,12 +4,13 @@ channels:
 - conda-forge
 - defaults
 dependencies:
-- python=3.7
+- doxygen
+- netlistsvg
+- pango
 - pip
 - pycairo
-- pango
 - pygobject
+- python=3.7
 - yosys
-- netlistsvg
 - pip:                            # Packages installed from PyPI
   - -r file:requirements.txt

docs/index.rst

@@ -1,38 +1,14 @@
 .. Wishbone Utilies documentation master file
 
+##################
 Wishbone Utilities
-==================
+##################
 
 A collection of utilities for working with Wishbone
 
-wishbone-tool
--------------
-
-.. toctree::
-   :maxdepth: 2
-   :glob:
-
-   wishbone-tool/index
-   wishbone-tool/*
-
-
-libeb-c
--------
-
 .. toctree::
-   :maxdepth: 2
-   :glob:
-
-   libeb-c/index
-   libeb-c/*
-
 
-litex-devmem2
--------------
-
-.. toctree::
-   :maxdepth: 2
-   :glob:
 
-   litex-devmem2/index
-   litex-devmem2/*
+   wishbone-tool
+   libeb-c
+   litex-devmem2

docs/libeb-c.rst

@@ -0,0 +1,15 @@
+#######
+libeb-c
+#######
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   libeb-c/*
+
+.. toctree::
+   :maxdepth: 3
+   :glob:
+
+   libeb-c-api/library_root.rst

docs/litex-devmem2.rst

@@ -0,0 +1,10 @@
+=============
+litex-devmem2
+=============
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   litex-devmem2/index
+   litex-devmem2/*

docs/requirements.txt

@@ -5,8 +5,7 @@ sphinxcontrib-napoleon
 
 # Better looking Sphinx theme
 # sphinx_materialdesign_theme
-git+http://github.com/SymbiFlow/sphinx_materialdesign_theme.git@master#egg=sphinx_symbiflow_theme
-
+git+https://github.com/SymbiFlow/sphinx_materialdesign_theme.git@master#egg=sphinx_symbiflow_theme
 
 # Support copying without prompts.
 git+https://github.com/mithro/sphinxcontrib-session.git#egg=sphinxcontrib-session
@@ -16,7 +15,6 @@ git+https://github.com/mithro/sphinxcontrib-session.git#egg=sphinxcontrib-sessio
 breathe
 exhale
 
-
 # HDL specific functionality
 # --------------------------------------
 

docs/wishbone-tool.rst

@@ -0,0 +1,10 @@
+=============
+wishbone-tool
+=============
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   wishbone-tool/index
+   wishbone-tool/*

libeb-c/README.rst

@@ -1,5 +1,5 @@
-libeb
-=====
+Etherbone C Library
+===================
 
 A library that can be used for communicating with a remote device.