docs: use autoprogram

Signed-off-by: Unai Martinez-Corral <[email protected]>
chipsalliance · Apr 25, 2023 · 0f672ac · 0f672ac
1 parent 213e766
commit 0f672ac
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -20,15 +20,14 @@
 # Updated documentation of the configuration options is available at
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-import sys, os
+from sys import path as sys_path
 from pathlib import Path
 
 from tabulate import tabulate
 
 ROOT = Path(__file__).resolve().parent
 
-#sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, str(ROOT))
+sys_path.insert(0, str(ROOT))
 
 from changes import generate_changes_inc
 
@@ -69,6 +68,7 @@
 extensions = [
     'sphinx.ext.extlinks',
     'sphinx.ext.intersphinx',
+    "sphinxcontrib.autoprogram",
     'sphinx_verilog_domain',
     'sphinxcontrib.bibtex',
     'myst_parser'

diff --git a/docs/f4pga/Reference.rst b/docs/f4pga/Reference.rst
@@ -0,0 +1,6 @@
+Reference
+#########
+
+.. autoprogram:: f4pga.cli:CLI().MainParser
+  :prog: f4pga
+  :groups:
diff --git a/docs/index.rst b/docs/index.rst
@@ -66,6 +66,7 @@ Table of Contents
   f4pga/Usage
   f4pga/modules/index
   f4pga/DevNotes
+  f4pga/Reference
   f4pga/Deprecated
 
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,6 +1,8 @@
+-r ../f4pga/requirements.txt
 myst-parser
 pyyaml
 sphinx>=4.5.0
+sphinxcontrib-autoprogram
 sphinxcontrib-bibtex
 https://github.com/f4pga/sphinx_f4pga_theme/archive/f4pga.zip#sphinx-f4pga-theme
 https://github.com/SymbiFlow/sphinx-verilog-domain/archive/master.zip#sphinx-verilog-domain