Implement rustdoc-scrape-examples #2070
Conversation
There was a problem hiding this comment.
Nice, this looks great to me!
Few various tidy-up suggestions etc.
I also haven't touched the makefile yet - should I?
If you agree we should move towards cargo aliases (with "xtask" like in #2067 for more complex scripts), we can work to kill off the Makefile? If so, then don't worry about updating it here.
| - if: matrix.msrv == 'MSRV' | ||
| name: Prepare minimal package versions (MSRV only) | ||
| run: | | ||
| cargo update -p indexmap --precise 1.6.2 | ||
| cargo update -p hashbrown:0.11.2 --precise 0.9.1 | ||
|
|
||
| - name: Build docs | ||
| run: cargo doc --no-deps --no-default-features --features "${{ steps.settings.outputs.all_additive_features }}" | ||
| run: cargo doc --no-deps --no-default-features --features full |
There was a problem hiding this comment.
Should this become cargo pyo3_doc ?
There was a problem hiding this comment.
Actually, would you be OK with removing this step? Building docs is also tested in guide.yml.
There was a problem hiding this comment.
Hmmm, I do think there's value in checking the docs build on all each of windows, Linux and macos. Probably doesn't need to be run for each Python variant. Could make it 3.10-only?
I'm not sure I even want to change it now, seeing as it seems to work fine as it is (I'm guessing the rustdocflags don't get passed for some reason?). Moving it to guide.yml and rendering docs for each possible combination of cfgs would require rebuilding pyo3 for each of those (?). |
|
Mmm ok, let's keep as-is for now! |
This implements
rustdoc-scrape-examplesfor the docs that we host ourselves (not the docs.rs ones - I figure it's best to see how this goes first). Example.This also:
fullfeature that incorporates all additional features__call__example in the guideNote that this creates a dead link to "decorator" in the sidebar. This should be fixed by rust-lang/rust#92146
I also haven't touched the makefile yet - should I?