Skip to content

Commit

Permalink
MNT: typo correction
Browse files Browse the repository at this point in the history
  • Loading branch information
dgursoy committed Mar 30, 2015
1 parent e1eabfa commit 34b0043
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 19 deletions.
28 changes: 14 additions & 14 deletions doc/developer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,27 @@ For Beginners

Short descriptions of some of the files in the root folder of the project:

* .gitignore : Specifies intentionally untracked files that
`Git <http://git-scm.com>`_ should ignore.
:.gitignore: Specifies intentionally untracked files that
`Git <http://git-scm.com>`_ should ignore.

* bld.bat : Windows build script which is executed using ``cmd``.
:bld.bat: Windows build script which is executed using ``cmd``.

* build.sh : Unix build script which is executed using bash.
:build.sh: Unix build script which is executed using bash.

* MANIFEST.in : Specifies the files in the project that will go into the
final distribution.
:MANIFEST.in: Specifies the files in the project that will go into the
final distribution.

* meta.yaml : Contains metadata for the
`Conda <http://conda.pydata.org/docs/build.html>`_ build.
:meta.yaml: Contains metadata for the
`Conda <http://conda.pydata.org/docs/build.html>`_ build.

* requirements.txt : Contains a list of items to be installed using
`pip install <https://pip.pypa.io/en/latest/user_guide.html#requirements-files>`_
:requirements.txt: Contains a list of items to be installed using
`pip install <https://pip.pypa.io/en/latest/user_guide.html#requirements-files>`_

* setup.cfg : Contains the distribution's optional metadata and build
configuration which are not provided in ``setup.py``
:setup.cfg: Contains the distribution's optional metadata and build
configuration which are not provided in ``setup.py``

* setup.py : Contains metadata and configuration for building and
installing the package distribution.
:setup.py: Contains metadata and configuration for building and
installing the package distribution.


Coding Syntax
Expand Down
8 changes: 3 additions & 5 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,11 @@
TomoPy Guide
============

TomoPy is a Python toolbox to perform data processing and
image reconstruction tasks. This is a test bed and will be
merged with `TomoPy <https://github.com/tomopy/tomopy.git>`_
once matured.
TomoPy is a Python toolbox to perform tomographic data processing and image
reconstruction tasks at the `Advanced Photon Source <http://www.aps.anl.gov>`_.

This guide is currently maintained on
`GitHub <https://github.com/dgursoy/tomogrid>`_.
`GitHub <https://github.com/dgursoy/tomopy>`_.

.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit 34b0043

Please sign in to comment.