panel icon indicating copy to clipboard operation
panel copied to clipboard

Add clean-docs task?

Open cdeil opened this issue 1 year ago • 1 comments

I sometimes see something in the docs that I'd like to improve (example: #7179) but then I almost never manage to get the docs build to succeed at all, or if I do it takes 10s of minutes or an hour and still I'm not sure if / when my edit is picked up.

@MarcSkovMadsen - thanks for #7218 and making the docs build steps more prominent in the dev docs!

Would it make sense to in addition have one or a few clean-docs pixi tasks?

For me it's very difficult to understand in which folders files are auto-generated at all and how to get a "clean slate" if seemingly my docs edit doesn't take effect. Having the rm of those files/folders as a task would make it easier for me to open the pixi.toml and see / remember this.

Is it clear which docs steps support incremental build in the sense that they should "just work" and pick up edits e.g. to a docstring or an example or ... and which one require full build or even manual rm to clean?

cdeil avatar Sep 01 '24 11:09 cdeil

+1

philippjfr avatar Sep 01 '24 15:09 philippjfr