Docs build fixes #45
Docs build fixes #45
Conversation
* do not strip module names from file paths in `make-autodocs` * do not tell `sphinx-autosummary` to generate its own stubs * work with `no_saltext_namespace` * report exit status >0 if something changed for pre-commit
__file__ is not set in GH workflows and needlessly complex
|
The underlying issue is still valid, without this the docs are pretty broken afair. If this tool is still intended to be the official way to create an extension, I think it should be fixed. In the copier template, I included some additional changes built on top of this PR:
I'm happy to contribute those in a separate PR if desired. |
|
If the copier template is better and more maintainable than this code, I'm in favor of advising users to use that instead. |
|
I do think it's a bit more maintainable and easier to add new functionality to, in addition to allowing boilerplate updates for existing projects. We should probably transfer it into the |
|
A discussion should happen in the salt-extensions working group on which tool to send the users too. In the meantime, I'm merging in these fixes. |
Fixes: #44
Based on #42 because there are no requirement files to fix in this repo before merging it