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

fix sphinx-init --fail-on-error trailing backslash #409

Merged

Conversation

briantist
Copy link
Contributor

I found that using --fail-on-error with sphinx-init resulted in a broken build.sh due to a missing trailing backslash.

Example:

#!/usr/bin/env bash
set -e
cd /home/runner/work/_temp/docsbuild

# Create collection documentation into temporary directory
rm -rf temp-rst
mkdir -p temp-rst
antsibull-docs collection \
    --fail-on-error
    --use-current \
    --no-use-html-blobs \
    --breadcrumbs \
    --indexes \
    --dest-dir temp-rst \
    lowlydba.sqlserver

# Copy collection documentation into source directory
rsync -cprv --delete-after temp-rst/collections/ rst/collections/

# Build Sphinx site
sphinx-build -M html rst build -c . -W --keep-going

@felixfontein
Copy link
Collaborator

Code looks good, but can you please add a changelog fragment? Thanks :)

Co-authored-by: Felix Fontein <felix@fontein.de>
@briantist briantist requested a review from felixfontein March 27, 2022 13:48
@felixfontein felixfontein merged commit 0a08972 into ansible-community:main Mar 27, 2022
@felixfontein
Copy link
Collaborator

@briantist thanks for fixing this!

@briantist
Copy link
Contributor Author

@felixfontein thanks! please let know when this change is released, have a few things in flight that will need this 😀

@felixfontein
Copy link
Collaborator

I was thinking of waiting for a run of the test docsite build (for ansible/ansible#77362). I hope that can happen tomorrow...

@briantist
Copy link
Contributor Author

I was thinking of waiting for a run of the test docsite build (for ansible/ansible#77362). I hope that can happen tomorrow...

Sounds good to me, not a huge rush, a comment here or a ping on IRC when it's released would be great if you remember 🙏

@briantist briantist deleted the sphinx-init/fail-on-error branch March 27, 2022 16:44
@felixfontein
Copy link
Collaborator

@briantist I just released 0.42.1 with this fix.

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.

2 participants