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

sphinx-build clean does not clean generated docs by automodapi #156

Open
maxnoe opened this issue Dec 20, 2022 · 7 comments
Open

sphinx-build clean does not clean generated docs by automodapi #156

maxnoe opened this issue Dec 20, 2022 · 7 comments
Labels

Comments

@maxnoe
Copy link
Member

maxnoe commented Dec 20, 2022

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

@pllim
Copy link
Member

pllim commented Dec 20, 2022

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

@pllim pllim added the question label Dec 20, 2022
@maxnoe
Copy link
Member Author

maxnoe commented Dec 20, 2022

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"

@pllim
Copy link
Member

pllim commented Dec 20, 2022

That I am not sure, maybe @eteq knows.

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

@maxnoe
Copy link
Member Author

maxnoe commented Dec 20, 2022

How does the theme address auto generated docs?

@pllim
Copy link
Member

pllim commented Dec 20, 2022

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.

@maxnoe
Copy link
Member Author

maxnoe commented Dec 20, 2022

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

@pllim
Copy link
Member

pllim commented Dec 20, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants