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

Antsibull-docs 1.2.0 builds all docs instead of just our collection #16

Closed
LvffY opened this issue Aug 3, 2022 · 2 comments · Fixed by #17
Closed

Antsibull-docs 1.2.0 builds all docs instead of just our collection #16

LvffY opened this issue Aug 3, 2022 · 2 comments · Fixed by #17

Comments

@LvffY
Copy link

LvffY commented Aug 3, 2022

I'm building my collection doc with antsibull-docs.

Since today (03/08/2022) and the release of antsibull-docs 1.2.0, when building my collection docs all ansible collections docs are built (and so fails because I don't have all collections locally.)

How to reproduce

mkdir -p ~/tmp/docs
export ANSIBLE_COLLECTIONS_PATH=/path/to/your/collection
antsibull-docs sphinx-init --use-current --dest-dir ~/tmp/docs namespace.collection
cd ~/tmp/docs
pip install --upgrade -r requirements.txt
./build.sh

Here you should trying to build documentation for multiple collections and not only yours.

Workaround

As a temporary workaround you could :

  • Create a constraints file like
antsibull-docs<1.2.0
  • Then re-run the following commands :
mkdir -p ~/tmp/docs
export ANSIBLE_COLLECTIONS_PATH=/path/to/your/collection
antsibull-docs sphinx-init --use-current --dest-dir ~/tmp/docs namespace.collection
cd ~/tmp/docs
pip install --upgrade -r requirements.txt -c /path/to/your/constraints.txt ## Just use your constraint file here, to avoid installing antsibull-docs 1.2.0
./build.sh
@felixfontein
Copy link
Collaborator

This was introduced in 64a17fd#diff-f84a9e8a81549185f5ce78715bbecd163e4faca0bc544471b03888de680d2b15R229, the collection_names param must be passed in that line as well.

@felixfontein
Copy link
Collaborator

Fixed by #17.

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