Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docgen integration for testing the docstrings in CI #227

Merged
merged 4 commits into from
Dec 17, 2024

Conversation

callendorph
Copy link
Contributor

No description provided.

This runs docgen on the JSL packages so that we can
check for docstring errors before merging
@callendorph
Copy link
Contributor Author

OK - so, it at least runs -- but I geet errors for links that can't be found:

jitx-client-1  | Error: Link target not found for source LinkNode(symbol = "SolderMaskRegistration", kind = SrcDefType, alt-text = false) (source-package=jsl/landpatterns/pads).
jitx-client-1  | Error: Link target not found for source LinkNode(symbol = "Rectangle", kind = SrcDefType, alt-text = false) (source-package=jsl/landpatterns/pad-planner).
jitx-client-1  | Error: Link target not found for source LinkNode(symbol = "RoundedRectangle", kind = SrcDefType, alt-text = false) (source-package=jsl/landpatterns/pad-planner).
jitx-client-1  | Error: Link target not found for source LinkNode(symbol = "Capsule", kind = SrcDefType, alt-text = false) (source-package=jsl/landpatterns/pad-planner).
jitx-client-1  | Error: Link target not found for source LinkNode(symbol = "Dims", kind = SrcDefType, alt-text = false) (source-package=jsl/landpatterns/pad-planner).
jitx-client-1  | Error: Link target not found for source LinkNode(symbol = "Dims", kind = SrcDefType, alt-text = false) (source-package=jsl/landpatterns/pad-planner).
jitx-client-1  | Error: Link target not found for source LinkNode(symbol = "C", kind = SrcDefType, alt-text = false) (source-package=jsl/landpatterns/helpers).

I'm not including the definitions from the JITX runtime - so I think I can fix that by referencing the *.pkg files.

@callendorph
Copy link
Contributor Author

OK - there are some warnings - but the docs generator is now running:

jitx-client-1  | Unhandled Binary Pkg Extraction: jitx
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/signal-models
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/percentage
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/grid-locs
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/transform
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/shapes
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/ref
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/preconditions
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/layer-specs
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/emodels
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/interval
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/parts/component-types
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/emodel-types
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/anchor
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/parts/component-code
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/commands
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/pose
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/schematic-table
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/toleranced
jitx-client-1  | Unhandled Binary Pkg Extraction: jitx/stateful
jitx-client-1  | Warning: Undocumented package 'jsl/circuits/Termination' is forwarded by 'jsl/circuits'
jitx-client-1  | Warning: Undocumented package 'jsl/protocols/memory' is forwarded by 'jsl/protocols'
jitx-client-1  | Warning: Undocumented package 'jsl/protocols/memory/ddr4' is forwarded by 'jsl/protocols'
jitx-client-1  | Warning: Package jsl/landpatterns/pad-planner imports package jitx with 'only' and/or 'prefix'.  hese are currently unsupported by docgen and will be ignored.
jitx-client-1  | Warning: Package jsl/landpatterns/IPC imports package jsl/landpatterns/leads with 'only' and/or 'prefix'.  hese are currently unsupported by docgen and will be ignored.
jitx-client-1  | Warning: Package jsl/landpatterns/two-pin/SMT imports package jsl/landpatterns/two-pin/SMT-table with 'only' and/or 'prefix'.  hese are currently unsupported by docgen and will be ignored.
jitx-client-1  | Warning: Package jsl/landpatterns/leads/protrusions imports package jsl/landpatterns/leads/lead-fillets-table with 'only' and/or 'prefix'.  hese are currently unsupported by docgen and will be ignored.
jitx-client-1  | Warning: Package jsl/landpatterns/package-body imports package jsl/geometry/basics with 'only' and/or 'prefix'.  hese are currently unsupported by docgen and will be ignored.
jitx-client-1  | Warning: Package jsl/landpatterns/pads imports package jitx/commands with 'only' and/or 'prefix'.  hese are currently unsupported by docgen and will be ignored.
jitx-client-1  | Warning: Package jsl/landpatterns/courtyard imports package jsl/landpatterns/packages with 'only' and/or 'prefix'.  hese are currently unsupported by docgen and will be ignored.
jitx-client-1  | Warning: Ambiguous link resolution for LinkNode(symbol = "bounds", kind = SrcDefUnknown, alt-text = false). Possible targets:
jitx-client-1  | SymbolLinkTarget(symbol = "bounds", package = "jsl/landpatterns/leads", kind = SrcDefFunction, public? = true, url = "/reference/jsl/landpatterns/leads.md#defn_bounds")
jitx-client-1  | SymbolLinkTarget(symbol = "bounds", package = "jsl/geometry/box", kind = SrcDefFunction, public? = true, url = "/reference/jsl/geometry/box.md#defn_bounds")
jitx-client-1  | SymbolLinkTarget(symbol = "bounds", package = "jsl/geometry/basics", kind = SrcDefFunction, public? = true, url = "/reference/jsl/geometry/basics.md#defn_bounds")
Aborting on container exit...
jitx-client-1 exited with code 0

@callendorph callendorph requested a review from jwatson0 December 13, 2024 22:41
@callendorph callendorph merged commit a519ff8 into main Dec 17, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants