Skip to content

Commit b77c5b4

Browse files
thewtexthewtex
authored
Merge pull request InsightSoftwareConsortium#47 from thewtex/install-command
doc: update install command
2 parents 5b539f5 + 2a7cb55 commit b77c5b4

2 files changed

Lines changed: 15 additions & 11 deletions

File tree

‎README.rst‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
Welcome to ITKPythonPackage's documentation!
22
============================================
33

4-
This project provides a ``setup.py`` script that build ITK Python wheels.
4+
This project provides a ``setup.py`` script to build ITK Python wheels.
55

66
ITK is an open-source, cross-platform system that provides developers with an extensive suite of software tools for image analysis.
77

88
The Python packages are built daily. To install the ITK Python package::
99

1010
$ python -m pip install --upgrade pip
11-
$ python -m pip install itk -f https://github.com/InsightSoftwareConsortium/ITKPythonPackage/releases/tag/latest
11+
$ python -m pip install itk
1212

13-
For more information on ITK's Python wrapping, see an introduction in the ITK Software Guide. There are also many downloadable examples documented in Sphinx.
13+
For more information on ITK's Python wrapping, see `an introduction in the ITK
14+
Software Guide
15+
<https://itk.org/ITKSoftwareGuide/html/Book1/ITKSoftwareGuide-Book1ch3.html#x32-420003.7>`_.
16+
There are also many `downloadable examples documented in Sphinx
17+
<https://itk.org/ITKExamples/search.html?q=Python>`_.
1418

1519
* Free software: Apache Software license
1620
* Documentation: http://itkpythonpackage.readthedocs.org

‎docs/index.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
.. ITKPythonPackage documentation master file, created by
2-
sphinx-quickstart on Mon May 29 14:09:52 2017.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
5-
61
Welcome to ITKPythonPackage's documentation!
72
============================================
83

9-
This project provides a ``setup.py`` script that build ITK Python wheels.
4+
This project provides a ``setup.py`` script to build ITK Python wheels.
105

116
ITK is an open-source, cross-platform system that provides developers with an extensive suite of software tools for image analysis.
127

138
The Python packages are built daily. To install the ITK Python package::
149

1510
$ python -m pip install --upgrade pip
16-
$ python -m pip install itk -f https://github.com/InsightSoftwareConsortium/ITKPythonPackage/releases/tag/latest
11+
$ python -m pip install itk
12+
13+
For more information on ITK's Python wrapping, see `an introduction in the ITK
14+
Software Guide
15+
<https://itk.org/ITKSoftwareGuide/html/Book1/ITKSoftwareGuide-Book1ch3.html#x32-420003.7>`_.
16+
There are also many `downloadable examples documented in Sphinx
17+
<https://itk.org/ITKExamples/search.html?q=Python>`_.
1718

18-
For more information on ITK's Python wrapping, see an introduction in the ITK Software Guide. There are also many downloadable examples documented in Sphinx.
1919

2020
.. toctree::
2121
:maxdepth: 2

0 commit comments

Comments
 (0)