Skip to content

Commit 358e575

Browse files
committed
DOC: Move logo and badges out of long description into README
* Create top-level header in index.rst * Remove duplicate definition of MIT License URL
1 parent 625c75b commit 358e575

File tree

3 files changed

+41
-104
lines changed

3 files changed

+41
-104
lines changed

README.rst

+33-32
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,10 @@
11
.. -*- rest -*-
22
.. vim:syntax=rst
33
4-
.. Following contents should be copied from LONG_DESCRIPTION in nibabel/info.py
5-
64
.. image:: doc/pics/logo.png
75
:target: https://nipy.org/nibabel
86
:alt: NiBabel logo
97

10-
Read and write access to common neuroimaging file formats, including: ANALYZE_ (plain, SPM99, SPM2 and later),
11-
GIFTI_, NIfTI1_, NIfTI2_, `CIFTI-2`_, MINC1_, MINC2_, `AFNI BRIK/HEAD`_, ECAT_ and Philips PAR/REC.
12-
In addition, NiBabel also supports FreeSurfer_'s MGH_, geometry, annotation and morphometry files,
13-
and provides some limited support for DICOM_.
14-
15-
NiBabel's API gives full or selective access to header information (metadata), and image
16-
data is made available via NumPy arrays. For more information, see NiBabel's `documentation site`_
17-
and `API reference`_.
18-
19-
.. _API reference: https://nipy.org/nibabel/api.html
20-
.. _AFNI BRIK/HEAD: https://afni.nimh.nih.gov/pub/dist/src/README.attributes
21-
.. _ANALYZE: http://www.grahamwideman.com/gw/brain/analyze/formatdoc.htm
22-
.. _CIFTI-2: https://www.nitrc.org/projects/cifti/
23-
.. _DICOM: http://medical.nema.org/
24-
.. _documentation site: http://nipy.org/nibabel
25-
.. _ECAT: http://xmedcon.sourceforge.net/Docs/Ecat
26-
.. _Freesurfer: https://surfer.nmr.mgh.harvard.edu
27-
.. _GIFTI: https://www.nitrc.org/projects/gifti
28-
.. _MGH: https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/MghFormat
29-
.. _MINC1:
30-
https://en.wikibooks.org/wiki/MINC/Reference/MINC1_File_Format_Reference
31-
.. _MINC2:
32-
https://en.wikibooks.org/wiki/MINC/Reference/MINC2.0_File_Format_Reference
33-
.. _NIfTI1: http://nifti.nimh.nih.gov/nifti-1/
34-
.. _NIfTI2: http://nifti.nimh.nih.gov/nifti-2/
35-
368
.. list-table::
379
:widths: 20 80
3810
:header-rows: 0
@@ -97,6 +69,35 @@ and `API reference`_.
9769
:target: https://doi.org/10.5281/zenodo.591597
9870
:alt: Zenodo DOI
9971

72+
.. Following contents should be copied from LONG_DESCRIPTION in nibabel/info.py
73+
74+
75+
Read and write access to common neuroimaging file formats, including: ANALYZE_ (plain, SPM99, SPM2 and later),
76+
GIFTI_, NIfTI1_, NIfTI2_, `CIFTI-2`_, MINC1_, MINC2_, `AFNI BRIK/HEAD`_, ECAT_ and Philips PAR/REC.
77+
In addition, NiBabel also supports FreeSurfer_'s MGH_, geometry, annotation and morphometry files,
78+
and provides some limited support for DICOM_.
79+
80+
NiBabel's API gives full or selective access to header information (metadata), and image
81+
data is made available via NumPy arrays. For more information, see NiBabel's `documentation site`_
82+
and `API reference`_.
83+
84+
.. _API reference: https://nipy.org/nibabel/api.html
85+
.. _AFNI BRIK/HEAD: https://afni.nimh.nih.gov/pub/dist/src/README.attributes
86+
.. _ANALYZE: http://www.grahamwideman.com/gw/brain/analyze/formatdoc.htm
87+
.. _CIFTI-2: https://www.nitrc.org/projects/cifti/
88+
.. _DICOM: http://medical.nema.org/
89+
.. _documentation site: http://nipy.org/nibabel
90+
.. _ECAT: http://xmedcon.sourceforge.net/Docs/Ecat
91+
.. _Freesurfer: https://surfer.nmr.mgh.harvard.edu
92+
.. _GIFTI: https://www.nitrc.org/projects/gifti
93+
.. _MGH: https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/MghFormat
94+
.. _MINC1:
95+
https://en.wikibooks.org/wiki/MINC/Reference/MINC1_File_Format_Reference
96+
.. _MINC2:
97+
https://en.wikibooks.org/wiki/MINC/Reference/MINC2.0_File_Format_Reference
98+
.. _NIfTI1: http://nifti.nimh.nih.gov/nifti-1/
99+
.. _NIfTI2: http://nifti.nimh.nih.gov/nifti-2/
100+
100101
Installation
101102
============
102103

@@ -128,13 +129,13 @@ Please send any questions or suggestions to the `neuroimaging mailing list
128129
License
129130
=======
130131

131-
NiBabel is licensed under the terms of the `MIT license`_. Some code included
132-
with NiBabel is licensed under the `BSD license`_. For more information,
133-
please see the COPYING_ file.
132+
NiBabel is licensed under the terms of the `MIT license
133+
<https://github.com/nipy/nibabel/blob/master/COPYING#nibabel>`__.
134+
Some code included with NiBabel is licensed under the `BSD license`_.
135+
For more information, please see the COPYING_ file.
134136

135137
.. _BSD license: https://opensource.org/licenses/BSD-3-Clause
136138
.. _COPYING: https://github.com/nipy/nibabel/blob/master/COPYING
137-
.. _MIT license: https://github.com/nipy/nibabel/blob/master/COPYING#nibabel
138139

139140
Citation
140141
========

doc/source/index.rst

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
#
88
### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
99
10+
=======
11+
NiBabel
12+
=======
13+
1014
.. include:: _long_description.inc
1115

1216
Documentation

nibabel/info.py

+4-72
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@
1212
# We also include this text in the docs by ``..include::`` in
1313
# ``docs/source/index.rst``.
1414
long_description = """
15-
.. image:: doc/pics/logo.png
16-
:target: https://nipy.org/nibabel
17-
:alt: NiBabel logo
18-
1915
Read and write access to common neuroimaging file formats, including: ANALYZE_ (plain, SPM99, SPM2 and later),
2016
GIFTI_, NIfTI1_, NIfTI2_, `CIFTI-2`_, MINC1_, MINC2_, `AFNI BRIK/HEAD`_, ECAT_ and Philips PAR/REC.
2117
In addition, NiBabel also supports FreeSurfer_'s MGH_, geometry, annotation and morphometry files,
@@ -42,70 +38,6 @@
4238
.. _NIfTI1: http://nifti.nimh.nih.gov/nifti-1/
4339
.. _NIfTI2: http://nifti.nimh.nih.gov/nifti-2/
4440
45-
.. list-table::
46-
:widths: 20 80
47-
:header-rows: 0
48-
49-
* - Code
50-
-
51-
.. image:: https://img.shields.io/pypi/pyversions/nibabel.svg
52-
:target: https://pypi.python.org/pypi/nibabel/
53-
:alt: PyPI - Python Version
54-
.. image:: https://img.shields.io/badge/code%20style-blue-blue.svg
55-
:target: https://blue.readthedocs.io/en/latest/
56-
:alt: code style: blue
57-
.. image:: https://img.shields.io/badge/imports-isort-1674b1
58-
:target: https://pycqa.github.io/isort/
59-
:alt: imports: isort
60-
.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
61-
:target: https://github.com/pre-commit/pre-commit
62-
:alt: pre-commit
63-
64-
* - Tests
65-
-
66-
.. image:: https://github.com/nipy/NiBabel/actions/workflows/stable.yml/badge.svg
67-
:target: https://github.com/nipy/NiBabel/actions/workflows/stable.yml
68-
:alt: stable tests
69-
.. image:: https://codecov.io/gh/nipy/NiBabel/branch/master/graph/badge.svg
70-
:target: https://codecov.io/gh/nipy/NiBabel
71-
:alt: codecov badge
72-
73-
* - PyPI
74-
-
75-
.. image:: https://img.shields.io/pypi/v/nibabel.svg
76-
:target: https://pypi.python.org/pypi/nibabel/
77-
:alt: PyPI version
78-
.. image:: https://img.shields.io/pypi/dm/nibabel.svg
79-
:target: https://pypistats.org/packages/nibabel
80-
:alt: PyPI - Downloads
81-
82-
* - Packages
83-
-
84-
.. image:: https://img.shields.io/conda/vn/conda-forge/nibabel
85-
:target: https://anaconda.org/conda-forge/nibabel
86-
:alt: Conda package
87-
.. image:: https://repology.org/badge/version-for-repo/debian_unstable/nibabel.svg?header=Debian%20Unstable
88-
:target: https://repology.org/project/nibabel/versions
89-
:alt: Debian Unstable package
90-
.. image:: https://repology.org/badge/version-for-repo/aur/python:nibabel.svg?header=Arch%20%28%41%55%52%29
91-
:target: https://repology.org/project/python:nibabel/versions
92-
:alt: Arch (AUR)
93-
.. image:: https://repology.org/badge/version-for-repo/gentoo_ovl_science/nibabel.svg?header=Gentoo%20%28%3A%3Ascience%29
94-
:target: https://repology.org/project/nibabel/versions
95-
:alt: Gentoo (::science)
96-
.. image:: https://repology.org/badge/version-for-repo/nix_unstable/python:nibabel.svg?header=nixpkgs%20unstable
97-
:target: https://repology.org/project/python:nibabel/versions
98-
:alt: nixpkgs unstable
99-
100-
* - License & DOI
101-
-
102-
.. image:: https://img.shields.io/pypi/l/nibabel.svg
103-
:target: https://github.com/nipy/nibabel/blob/master/COPYING
104-
:alt: License
105-
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.591597.svg
106-
:target: https://doi.org/10.5281/zenodo.591597
107-
:alt: Zenodo DOI
108-
10941
Installation
11042
============
11143
@@ -137,13 +69,13 @@
13769
License
13870
=======
13971
140-
NiBabel is licensed under the terms of the `MIT license`_. Some code included
141-
with NiBabel is licensed under the `BSD license`_. For more information,
142-
please see the COPYING_ file.
72+
NiBabel is licensed under the terms of the `MIT license
73+
<https://github.com/nipy/nibabel/blob/master/COPYING#nibabel>`__.
74+
Some code included with NiBabel is licensed under the `BSD license`_.
75+
For more information, please see the COPYING_ file.
14376
14477
.. _BSD license: https://opensource.org/licenses/BSD-3-Clause
14578
.. _COPYING: https://github.com/nipy/nibabel/blob/master/COPYING
146-
.. _MIT license: https://github.com/nipy/nibabel/blob/master/COPYING#nibabel
14779
14880
Citation
14981
========

0 commit comments

Comments
 (0)