diff --git a/README.rst b/README.rst index ccb76e05..50c43048 100644 --- a/README.rst +++ b/README.rst @@ -1,16 +1,20 @@ Welcome to ITKPythonPackage's documentation! ============================================ -This project provides a ``setup.py`` script that build ITK Python wheels. +This project provides a ``setup.py`` script to build ITK Python wheels. ITK is an open-source, cross-platform system that provides developers with an extensive suite of software tools for image analysis. The Python packages are built daily. To install the ITK Python package:: $ python -m pip install --upgrade pip - $ python -m pip install itk -f https://github.com/InsightSoftwareConsortium/ITKPythonPackage/releases/tag/latest + $ python -m pip install itk -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. +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 +`_. * Free software: Apache Software license * Documentation: http://itkpythonpackage.readthedocs.org diff --git a/docs/index.rst b/docs/index.rst index 28ad03ea..b2748acb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,21 +1,21 @@ -.. ITKPythonPackage documentation master file, created by - sphinx-quickstart on Mon May 29 14:09:52 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - Welcome to ITKPythonPackage's documentation! ============================================ -This project provides a ``setup.py`` script that build ITK Python wheels. +This project provides a ``setup.py`` script to build ITK Python wheels. ITK is an open-source, cross-platform system that provides developers with an extensive suite of software tools for image analysis. The Python packages are built daily. To install the ITK Python package:: $ python -m pip install --upgrade pip - $ python -m pip install itk -f https://github.com/InsightSoftwareConsortium/ITKPythonPackage/releases/tag/latest + $ python -m pip install itk + +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 +`_. -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. .. toctree:: :maxdepth: 2