generate docs using antsibull #895
Conversation
evgeni
force-pushed
the
antsibull
branch
3 times, most recently
from
5c808a3
to
cf3f2c3
Compare
That's a good idea (it's the most annoying bug antsibull-docs has right now IMO). I've submitted a PR which fixes it (ansible-community/antsibull#146). |
evgeni
force-pushed
the
antsibull
branch
2 times, most recently
from
f812eb6
to
edb8113
Compare
Makefile
Outdated
| @@ -110,8 +110,11 @@ clean: | |||
| doc-setup: | |||
| pip install -r docs/requirements.txt | |||
| doc: $(MANIFEST) | |||
| mkdir -p ./docs/plugins/ ./build/plugin_docs | |||
| antsibull-docs collection --use-current --squash-hierarchy --dest-dir ./build/plugin_docs theforeman.foreman | |||
| cp -a ./build/plugin_docs/* ./docs/plugins/ | |||
There was a problem hiding this comment.
@mdellweg is that OK with you? It generates the docs in build, so we don't need to clean them up, but we need them in docs/plugins for Sphinx to pick them up later.
There was a problem hiding this comment.
Maybe we should add docs/plugins to the clean target.
For me to understand better: Docs are only rebuilt, if MANIFEST changed, which means something actually changed. I think, that's OK.
There was a problem hiding this comment.
Right, and then we can just build into that folder instead of copying things around.
this leaves docs/Makefile a vanilla Sphinx Makefile
|
no worries, thanks for the review! cleaned up history a bit and going to merge this now. |
This is an alternative to/superseeds #885
preview: https://people.redhat.com/evgeni/fam-antsibull/
I'd like to wait with merging this until ansible-community/antsibull#116 is fixedit's fixed