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

DOC: Migrate and update docs for building ITK Python wheels #4298

Merged

Conversation

tbirdso
Copy link
Contributor

@tbirdso tbirdso commented Nov 8, 2023

Migrate documentation for building ITK Python distributions and build archives with ITKPythonPackage.

Original source: https://github.com/InsightSoftwareConsortium/ITKPythonPackage/blob/master/docs/Build_ITK_Python_packages.rst

Includes updates for ITK v5.3.0 and removed obsolete sdist instructions.

PR Checklist

  • Updated API documentation (or API not changed)

Refer to the ITK Software Guide for
further development details if necessary.

@tbirdso tbirdso requested review from thewtex and dzenanz November 8, 2023 16:33
@github-actions github-actions bot added type:Documentation Documentation improvement or change area:Python wrapping Python bindings for a class area:Documentation Issues affecting the Documentation module labels Nov 8, 2023
@tbirdso tbirdso requested a review from jcfr November 8, 2023 16:50
Copy link
Member

@thewtex thewtex left a comment

Choose a reason for hiding this comment

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

Looks great!

If we can remove the prefixes from the shell commands, they will be copy-able from the UI.

Documentation/docs/contributing/python_packaging.md Outdated Show resolved Hide resolved
Documentation/docs/contributing/python_packaging.md Outdated Show resolved Hide resolved
Documentation/docs/contributing/python_packaging.md Outdated Show resolved Hide resolved
Documentation/docs/contributing/python_packaging.md Outdated Show resolved Hide resolved
Documentation/docs/contributing/python_packaging.md Outdated Show resolved Hide resolved
Documentation/docs/contributing/python_packaging.md Outdated Show resolved Hide resolved
@tbirdso tbirdso force-pushed the migrate-python-package-docs branch from 8d85c2a to 7faade2 Compare November 8, 2023 17:09
Migrate documentation for building ITK Python distributions and build
archives with ITKPythonPackage
Resolves issue where `yml` script tag is not recognized by Sphinx
@tbirdso tbirdso force-pushed the migrate-python-package-docs branch from 7faade2 to 70a17d7 Compare November 8, 2023 17:25
@tbirdso
Copy link
Contributor Author

tbirdso commented Nov 8, 2023

Received offline approval to merge from @thewtex 👍

@tbirdso tbirdso merged commit 8cf41b3 into InsightSoftwareConsortium:master Nov 8, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:Documentation Issues affecting the Documentation module area:Python wrapping Python bindings for a class type:Documentation Documentation improvement or change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants