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 to CI Build #224

Closed
wants to merge 7 commits into from
Closed

Add Docgen to CI Build #224

wants to merge 7 commits into from

Conversation

callendorph
Copy link
Contributor

This will hopefully check for docstring bugs so that we can make sure those get fixed before merging.

This runs docgen on the JSL packages so that we can
check for docstring errors before merging
@callendorph callendorph requested a review from jwatson0 December 11, 2024 19:11
@callendorph
Copy link
Contributor Author

callendorph commented Dec 11, 2024

docker on my OS-X brew installation is basically non-functional. I can't test locally so there may be a long string of commits here to get this working I'm working on getting an ubuntu VM up to debug this.

@callendorph
Copy link
Contributor Author

Tests passed but it didn't actually run what I told it to run. Something is wrong with the CI.

@callendorph
Copy link
Contributor Author

When I run in the VM I see this:

...
ols/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 -standalone src -o ./docs_build/docs
jitx-client-1  | Error: /app/jsl/src/si/pairs.stanza:144.12 Function 'topo-pair' has documentation for non-existent argument 'pairs'
jitx-client-1  | Error: Encountered 1 errors while reading documentation for package jsl/si/pairs
jitx-client-1  | Halting due to errors while reading package docs.
jitx-client-1  | make: *** [Makefile:92: test-docs] Error 255
jitx-client-1 exited with code 2
ubuntu@ip-172-31-18-60:~/jsl2/.github$ 

Which is what I want to happen - it fails on a documentation problem.

@callendorph
Copy link
Contributor Author

I'm going to create a new clean PR

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.

1 participant