Add Docgen - Attempt 2 - Electric Boogaloo

.github/jitx-client/Dockerfile

@@ -6,5 +6,5 @@ WORKDIR /app
 COPY ./user.params /root/.jitx/user.params
 COPY ./license /root/.jitx/license
 
-CMD ["/bin/bash", "-c", "apt update ; apt install make build-essential jq -y ; mkdir -p ~/.ssh/ ; curl -L https://api.github.com/meta | jq -r '.ssh_keys | .[]' | sed -e 's/^/github.com /' > ~/.ssh/known_hosts ; git config --global --replace-all safe.directory '*' ; export STANZA_CONFIG=/root/.jitx/current ; export SLM_ROOT_DIR=${STANZA_CONFIG}/slm ; export SLM_STANZA=jstanza ; export PATH=$PATH:${STANZA_CONFIG}/stanza:${SLM_ROOT_DIR} ; cat $STANZA_CONFIG/scripts/install-info.sh ; cd jsl ; make tests"]
- 
+CMD ["/bin/bash", "-c", "apt update ; apt install make build-essential jq -y ; mkdir -p ~/.ssh/ ; curl -L https://api.github.com/meta | jq -r '.ssh_keys | .[]' | sed -e 's/^/github.com /' > ~/.ssh/known_hosts ; git config --global --replace-all safe.directory '*' ; export STANZA_CONFIG=/root/.jitx/current ; export SLM_ROOT_DIR=${STANZA_CONFIG}/slm ; export SLM_STANZA=jstanza ; export PATH=$PATH:${STANZA_CONFIG}/stanza:${SLM_ROOT_DIR} ; cat $STANZA_CONFIG/scripts/install-info.sh ; cd jsl ; make tests ; make test-docs"]
+

.github/workflows/test.yml

@@ -27,4 +27,4 @@ jobs:
         run: |
           cd .github/
           echo -n "${{ secrets.JITX_LICENSE }}" > jitx-client/license
-          docker compose up --exit-code-from jitx-client
+          docker compose up --force-recreate --exit-code-from jitx-client

.gitignore

@@ -2,3 +2,6 @@
 .vscode
 .DS_Store
 designs
+
+docs_build/jsl_defs_db.dat
+docs_build/docs/

Makefile

@@ -74,6 +74,25 @@ tests: fetch-deps
 test-%: fetch-deps
 	$(STANZA) run-test $(JSL_TESTS) -tagged $(@:test-%=%) | grep -v "SKIP" | awk NF
 
+DOCS_DIR=./docs_build
+DOCGEN=$(DOCS_DIR)/.slm/deps/docgen/bin/docgen
+DEFS_DB=$(DOCS_DIR)/jsl_defs_db.dat
+
+build-docgen: fetch-deps
+	cd $(DOCS_DIR)
+	$(SLM) build
+	cd ..
+	test -f $(DOCGEN)
+
+
+DOC_PKGS_FILE := $(DOCS_DIR)/pkgs.txt
+PKGS := $(shell cat ${DOC_PKGS_FILE} | xargs)
+
+test-docs: build-docgen
+	$(STANZA) definitions-database ./stanza.proj -o $(DEFS_DB)
+	$(DOCGEN) generate $(DEFS_DB) -type mkdocs -pkgs $(PKGS) -standalone src -o $(DOCS_DIR)/docs
+
+
 .PHONY: clean
 clean:
 	$(STANZA) clean

docs_build/pkgs.txt

@@ -0,0 +1,158 @@
+jsl/utils
+jsl/via-structures
+jsl/ensure
+jsl/errors
+jsl/layerstack
+jsl/math
+jsl/bundles
+jsl/bundles/comms
+jsl/bundles/debug
+jsl/bundles/gates
+jsl/bundles/general
+jsl/circuits
+jsl/circuits/Bypass
+jsl/circuits/ConfigStrap
+jsl/circuits/CrystalResonator
+jsl/circuits/Network
+jsl/circuits/Pullups
+jsl/circuits/utils
+jsl/design/Classable
+jsl/design/E-Series
+jsl/design/introspection
+jsl/design/settings
+jsl/design/solvers
+jsl/geometry/LineRectangle
+jsl/geometry/NotchedShapes
+jsl/geometry/basics
+jsl/geometry/box
+jsl/landpatterns
+jsl/landpatterns/BGA/package
+jsl/landpatterns/BGA/pads
+jsl/landpatterns/BGA/planner
+jsl/landpatterns/BGA
+jsl/landpatterns/IPC
+jsl/landpatterns/QFN
+jsl/landpatterns/QFP
+jsl/landpatterns/SOIC
+jsl/landpatterns/SON
+jsl/landpatterns/SOP
+jsl/landpatterns/SOT
+jsl/landpatterns/VirtualLP
+jsl/landpatterns/courtyard
+jsl/landpatterns/dual-row
+jsl/landpatterns/framework
+jsl/landpatterns/generators
+jsl/landpatterns/grid-planner
+jsl/landpatterns/headers
+jsl/landpatterns/helpers
+jsl/landpatterns/introspection
+jsl/landpatterns/keep-outs
+jsl/landpatterns/leads
+jsl/landpatterns/leads/lead-fillets-table
+jsl/landpatterns/leads/lead-profile
+jsl/landpatterns/leads/lead-types
+jsl/landpatterns/leads/protrusions
+jsl/landpatterns/leads/through-hole
+jsl/landpatterns/numbering
+jsl/landpatterns/package-body
+jsl/landpatterns/packages
+jsl/landpatterns/pad-grid
+jsl/landpatterns/pad-island
+jsl/landpatterns/pad-planner
+jsl/landpatterns/pads
+jsl/landpatterns/quad
+jsl/landpatterns/silkscreen
+jsl/landpatterns/thermal-pads
+jsl/landpatterns/thermal-vias
+jsl/landpatterns/two-pin/SMT-table
+jsl/landpatterns/two-pin/SMT
+jsl/landpatterns/two-pin/axial
+jsl/landpatterns/two-pin/generators
+jsl/landpatterns/two-pin/molded
+jsl/landpatterns/two-pin/radial
+jsl/landpatterns/two-pin/utils
+jsl/pin-assignment
+jsl/pin-assignment/checks
+jsl/pin-assignment/circuit-pool
+jsl/pin-assignment/generators
+jsl/protocols
+jsl/protocols/displayport
+jsl/protocols/ethernet
+jsl/protocols/ethernet/MDI/MDI-1000Base-T
+jsl/protocols/ethernet/MDI/MDI-100Base-TX
+jsl/protocols/ethernet/MDI/e10GBASE-KR
+jsl/protocols/ethernet/MII/GMII
+jsl/protocols/ethernet/MII/MII
+jsl/protocols/ethernet/MII/MIIM
+jsl/protocols/ethernet/MII/RGMII
+jsl/protocols/ethernet/MII/RMII
+jsl/protocols/ethernet/utils
+jsl/protocols/memory/lpddr4
+jsl/protocols/memory/gddr7
+jsl/protocols/pcie
+jsl/protocols/sata
+jsl/protocols/usb
+jsl/si
+jsl/si/Microstrip
+jsl/si/TransmissionLine
+jsl/si/bus
+jsl/si/constraints
+jsl/si/couplers
+jsl/si/helpers
+jsl/si/pairs
+jsl/si/physics
+jsl/si/signal-ends
+jsl/symbols
+jsl/symbols/DIAC
+jsl/symbols/SCR
+jsl/symbols/SymbolDefn
+jsl/symbols/SymbolNode
+jsl/symbols/SymbolParams
+jsl/symbols/TRIAC
+jsl/symbols/ThreePinSymbol
+jsl/symbols/TwoPinSymbol
+jsl/symbols/arrows
+jsl/symbols/audio
+jsl/symbols/box-symbol/errors
+jsl/symbols/box-symbol/utils
+jsl/symbols/box-symbol
+jsl/symbols/capacitors
+jsl/symbols/comparator
+jsl/symbols/crystal
+jsl/symbols/decorators
+jsl/symbols/diode-bridge
+jsl/symbols/diodes
+jsl/symbols/ferrite
+jsl/symbols/framework
+jsl/symbols/generators
+jsl/symbols/hysteresis
+jsl/symbols/inductors
+jsl/symbols/instrumentation-amp
+jsl/symbols/logic/AND
+jsl/symbols/logic/OR
+jsl/symbols/logic/buffer
+jsl/symbols/logic/generators
+jsl/symbols/net-symbols
+jsl/symbols/net-symbols/bar-ground
+jsl/symbols/net-symbols/bar-power
+jsl/symbols/net-symbols/framework
+jsl/symbols/net-symbols/ground-symbol
+jsl/symbols/net-symbols/power-symbol
+jsl/symbols/net-symbols/symbol-builder
+jsl/symbols/op-amps
+jsl/symbols/pin-refs
+jsl/symbols/potentiometer
+jsl/symbols/resistors
+jsl/symbols/switches
+jsl/symbols/transformer
+jsl/symbols/transistors/BJT
+jsl/symbols/transistors/FET
+jsl/symbols/transistors/JFET
+jsl/symbols/transistors/generators
+jsl/symbols/utils
+jsl/examples/protocols/displayport/displayport-src
+jsl/examples/landpatterns/app-specific-keepout
+jsl/examples/protocols/common/example-board
+jsl/examples/protocols/sata/SATA-src
+jsl/examples/protocols/ethernet/10GBASE-KR/e10GBASE-KR-src
+jsl/examples/pin-assignment/swizzle

docs_build/slm.toml

@@ -0,0 +1,6 @@
+name = "jsl-build-deps"
+version = "0.1.0"
+[dependencies.docgen]
+pkg="docgen"
+version="0.1.6"
+type="conan"

docs_build/src/notused.stanza

@@ -0,0 +1,4 @@
+defpackage jsl-build-deps/notused:
+  import core
+
+println("This program is not used. It is just to get the dependencies")

docs_build/stanza.proj

@@ -0,0 +1,4 @@
+include? ".slm/stanza.proj"
+pkg-cache: ".slm/pkg-cache"
+
+packages jsl-build-deps/* defined-in "src/"