Skip to content

Commit 30a76aa

Browse files
committed
fix(docs): convert README.md to text/x-rst
1 parent 108973b commit 30a76aa

File tree

4 files changed

+36
-26
lines changed

4 files changed

+36
-26
lines changed

README.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

README.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
A Python client to query TemplateFlow
2+
=====================================
3+
4+
|DOI| |CircleCI| |Build Status| |Pypi|
5+
6+
Group inference and reporting of neuroimaging studies require that
7+
individual’s features are spatially aligned into a common frame where
8+
their location can be called standard. To that end, a multiplicity of
9+
brain templates with anatomical annotations (i.e., atlases) have been
10+
published. However, a centralized resource that allows programmatic
11+
access to templates is lacking. TemplateFlow is a modular,
12+
version-controlled resource that allows researchers to use templates
13+
“off-the-shelf” and share new ones.
14+
15+
.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.2583289.svg
16+
:target: https://doi.org/10.5281/zenodo.2583289
17+
.. |CircleCI| image:: https://circleci.com/gh/templateflow/python-client/tree/master.svg?style=shield
18+
:target: https://circleci.com/gh/templateflow/python-client/tree/master
19+
.. |Build Status| image:: https://travis-ci.org/templateflow/python-client.svg?branch=master
20+
:target: https://travis-ci.org/templateflow/python-client
21+
.. |Pypi| image:: https://img.shields.io/pypi/v/templateflow.svg
22+
:target: https://pypi.python.org/pypi/templateflow/

docs/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
About
44
-----
5-
.. include:: ../long_description.rst
5+
.. include:: ../README.rst
6+
:start-line: 3
67

78
Contents
89
--------

setup.cfg

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
[metadata]
2-
url = https://github.com/poldracklab/templateflow
3-
author = The CRN developers
4-
author_email = [email protected]
5-
maintainer = Oscar Esteban
6-
maintainer_email = [email protected]
7-
description = TemplateFlow Python Client - TemplateFlow is the Zone of neuroimaging templates.
8-
long_description = file:README.md
9-
long_description_content_type = text/markdown; charset=UTF-8
10-
license = Apache-2.0
2+
author = Oscar Esteban
113
classifiers =
124
Development Status :: 3 - Alpha
135
Intended Audience :: Science/Research
@@ -16,6 +8,17 @@ classifiers =
168
Programming Language :: Python :: 3.6
179
Programming Language :: Python :: 3.7
1810
Programming Language :: Python :: 3.8
11+
description = TemplateFlow Python Client - TemplateFlow is the Zone of neuroimaging templates.
12+
license = Apache-2.0
13+
long_description = file:README.rst
14+
long_description_content_type = text/x-rst; charset=UTF-8
15+
maintainer = The NiPreps developers
16+
maintainer_email = [email protected]
17+
project_urls =
18+
Documentation = https://www.templateflow.org/python-client/
19+
GitHub = https://github.com/templateflow/python-client
20+
Archive = https://github.com/templateflow/templateflow
21+
url = https://www.templateflow.org
1922

2023
[options]
2124
python_requires = >= 3.6

0 commit comments

Comments
 (0)