sphinx-automodapi icon indicating copy to clipboard operation
sphinx-automodapi copied to clipboard

`sphinx-build clean` does not clean generated docs by automodapi

Open maxnoe opened this issue 2 years ago • 7 comments

Is there a way to register "output" directories in extensions so that sphinx-build clean also cleans up the auto-generated output of automodapi?

maxnoe avatar Dec 20 '22 09:12 maxnoe

Yes, you modify the directives under clean: in docs/Makefile.

pllim avatar Dec 20 '22 15:12 pllim

That's what I am doing now, the question was if this could be somehow automatized by the plugin so that the standard makefile "just works"

maxnoe avatar Dec 20 '22 16:12 maxnoe

That I am not sure, maybe @eteq knows.

FWIW if we decide to go ahead with https://github.com/astropy/astropy-sphinx-theme/issues/29 (use pydata-sphinx-theme), then we might not even need this anymore in the future.

pllim avatar Dec 20 '22 16:12 pllim

How does the theme address auto generated docs?

maxnoe avatar Dec 20 '22 16:12 maxnoe

I am hoping the default style would look nice enough that we don't need a custom one...? But you're right, it is not guaranteed and no one has time to tackle it right now.

pllim avatar Dec 20 '22 16:12 pllim

Isn't autogenerating docs pages orthogonal to how the theme makes it look?

maxnoe avatar Dec 20 '22 16:12 maxnoe

While we doing the theme change, I would also be interested to see how numpy and scipy generating their API doc... but I am not speaking for the project.

pllim avatar Dec 20 '22 16:12 pllim