-
Notifications
You must be signed in to change notification settings - Fork 151
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
improve docs of generated library #899
base: master
Are you sure you want to change the base?
Conversation
b9e67af
to
0ccd6f9
Compare
It is nightly feature, is not it? |
The additional feature gate displays require building docs with nightly, but it is still possible to generate docs using stable without issues. docs.rs always builds the documentation with nightly. |
We possibly need a "doc workflow" (on stable & nightly). It can be independent job or added to one of existent. Could you work on this? |
You mean building the docs for the PACs generated as part of the CI? I could look into this.. I would probably have to adapt the |
Sure. #689 |
#905 is WIP and I already was thinking of how to best add this workflow. I saw that the bash script is used for the clippy check as well. If this is done by the regress tool, I am wondering what the best way would be to do the CI. The regress tool already takes care of creating new projects for each chip. One way would be to also run |
For checking if generated doc comments is correct it'd be enough to just run it with the regular per-target tests imo. |
This is enough |
This adds feature gate displays, for example like the ones in the syn docs.
The generated library only has a few of those, but I find them to be very useful. Fixes #855