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

Fixup docs publish job #850

Merged
merged 1 commit into from
Mar 30, 2023
Merged

Fixup docs publish job #850

merged 1 commit into from
Mar 30, 2023

Commits on Mar 29, 2023

  1. Fixup docs publish job

    This commit fixes two separate issues in the docs publishing job. The
    first is a failure that happens in the docs deployment on releases.
    The IFS (internal field separator) variable was getting set too broadly
    at the the level of the entire script instead of just the tag parsing.
    This was causing the passing of the secrets for decrypting the
    credential files to fail. This commit updates the IFS usage so it's not
    affecting the other commands after we split the tag version.
    
    The second change is updating the default sphinx-build invocation to
    include the -d flag to change the default output directory for the
    .doctrees dir.
    (see: https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-d
    for details on the flag). The .doctrees dir is a local cache of pickle
    files for parsed source files and doesn't need to be included in the
    build. By moving the default location for this outside our html build dir
    this will remove a lot of overhead from our uploaded docs as this cache
    can end up being quite large.
    mtreinish committed Mar 29, 2023
    Configuration menu
    Copy the full SHA
    394f1a6 View commit details
    Browse the repository at this point in the history