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

generate docs using antsibull #895

Merged
merged 4 commits into from Jul 28, 2020
Merged

generate docs using antsibull #895

merged 4 commits into from Jul 28, 2020

Conversation

evgeni
Copy link
Member

@evgeni evgeni commented Jul 22, 2020

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 fixed it's fixed

@evgeni evgeni force-pushed the antsibull branch 3 times, most recently from 5c808a3 to cf3f2c3 Compare Jul 22, 2020
@evgeni
Copy link
Member Author

@evgeni evgeni commented Jul 22, 2020

@melcorr @mdellweg might also be interesting for squeezer!

docs/Makefile Outdated Show resolved Hide resolved
docs/Makefile Outdated Show resolved Hide resolved
docs/requirements.txt Outdated Show resolved Hide resolved
@felixfontein
Copy link

@felixfontein felixfontein commented Jul 22, 2020

I'd like to wait with merging this until ansible-community/antsibull#116 is fixed

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 evgeni force-pushed the antsibull branch 2 times, most recently from f812eb6 to edb8113 Compare Jul 24, 2020
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/
Copy link
Member Author

@evgeni evgeni Jul 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Member

@mdellweg mdellweg Jul 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

@evgeni evgeni Jul 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, and then we can just build into that folder instead of copying things around.

Copy link
Member

@mdellweg mdellweg Jul 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess

@evgeni evgeni marked this pull request as ready for review Jul 24, 2020
@evgeni evgeni changed the base branch from master to develop Jul 24, 2020
Copy link
Member

@mdellweg mdellweg left a comment

Sorry for the detour with copying stuff around

@evgeni
Copy link
Member Author

@evgeni evgeni commented Jul 28, 2020

no worries, thanks for the review!

cleaned up history a bit and going to merge this now.

@evgeni evgeni merged commit 20eea3d into theforeman:develop Jul 28, 2020
12 checks passed
@evgeni evgeni deleted the antsibull branch Jul 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants