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

Build docs separate #122

Merged
merged 17 commits into from
Jul 20, 2024
Merged

Build docs separate #122

merged 17 commits into from
Jul 20, 2024

Conversation

NathanDunfield
Copy link
Member

Build the wheels with no docs and later use a separate script to build the docs. For the actual release, another script would “manually” insert the docs into the various snappy wheels (which are just zip files) before uploading to PyPI.

raise ValueError('Usage: add_doc_to_wheel docs.zip snappy.whl')

python = sys.executable
tmp_dir = tempfile.mkdtemp()
Copy link
Member

Choose a reason for hiding this comment

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

with tempfile.TemporaryDirectory() as tmp_dir:

might be more pythonic. Not sure whether cleaning up the tmp directory at the end is a feature (making debugging easier) or bug.

Copy link
Member Author

Choose a reason for hiding this comment

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

It was intended to make debugging easier.

- uses: actions/upload-artifact@v3
with:
name: doc
path: /__w/SnapPy/SnapPy/doc_src/_build/doc/*
Copy link
Member

Choose a reason for hiding this comment

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

It might be a mess to download all that stuff. Would it be hard to install zip in the container temporarily?

Copy link
Member Author

Choose a reason for hiding this comment

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

The upload-artifact action automatically puts the files in a single zipfile for easy download.

@NathanDunfield NathanDunfield merged commit 4dacd18 into master Jul 20, 2024
23 of 25 checks passed
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