From 86350e8c76ced4b1d0d9b0ebb8b6e4dd95f3c400 Mon Sep 17 00:00:00 2001 From: Zvi Baratz <z.baratz@gmail.com> Date: Tue, 21 Feb 2023 19:09:54 +0200 Subject: [PATCH 1/5] DOC: Merged duplicate README and index sections --- README.rst | 36 +++++++++++++++++++++++++----------- doc/source/index.rst | 33 --------------------------------- nibabel/info.py | 36 +++++++++++++++++++++++++----------- 3 files changed, 50 insertions(+), 55 deletions(-) diff --git a/README.rst b/README.rst index 45856f679..e397d3cf1 100644 --- a/README.rst +++ b/README.rst @@ -118,26 +118,40 @@ When working on NiBabel itself, it may be useful to install in "editable" mode:: For more information on previous releases, see the `release archive`_ or `development changelog`_. +Please find detailed `download and installation instructions +<installation>`_ in the manual. + .. _current release: https://pypi.python.org/pypi/NiBabel -.. _release archive: https://github.com/nipy/NiBabel/releases .. _development changelog: https://nipy.org/nibabel/changelog.html +.. _installation: https://nipy.org/nibabel/installation.html#installation +.. _release archive: https://github.com/nipy/NiBabel/releases -Mailing List -============ +Support +======= + +If you have problems installing the software or questions about usage, +documentation or anything else related to NiBabel, you can post to the NiPy +mailing list: neuroimaging@python.org [subscription_, archive_] + +The mailing list is the preferred way to announce changes and additions to the +project. You can also search the mailing list archive using the mailing list +archive search located in the sidebar of the NiBabel home page. +We recommend that anyone using NiBabel subscribes to the mailing list. -Please send any questions or suggestions to the `neuroimaging mailing list -<https://mail.python.org/mailman/listinfo/neuroimaging>`_. +.. _subscription: https://mail.python.org/mailman/listinfo/neuroimaging +.. _archive: https://mail.python.org/pipermail/neuroimaging License ======= -NiBabel is licensed under the terms of the `MIT license -<https://github.com/nipy/nibabel/blob/master/COPYING#nibabel>`__. -Some code included with NiBabel is licensed under the `BSD license`_. -For more information, please see the COPYING_ file. +NiBabel is free-software (beer and speech) and covered by the `MIT License`_. +This applies to all source code, documentation, examples and snippets inside +the source distribution (including this website). Please see the +`appendix of the manual <license>`_ for the copyright statement and the +full text of the license. -.. _BSD license: https://opensource.org/licenses/BSD-3-Clause -.. _COPYING: https://github.com/nipy/nibabel/blob/master/COPYING +.. _license: https://nipy.org/nibabel/legal.html#license +.. _MIT License: https://opensource.org/license17s/MIT Citation ======== diff --git a/doc/source/index.rst b/doc/source/index.rst index 701de0136..aca34cce9 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -124,41 +124,8 @@ contributed code and discussion (in rough order of appearance): * Jérôme Dockès * Jacob Roberts -License reprise -=============== - -NiBabel is free-software (beer and speech) and covered by the `MIT License`_. -This applies to all source code, documentation, examples and snippets inside -the source distribution (including this website). Please see the -:ref:`appendix of the manual <license>` for the copyright statement and the -full text of the license. - -Download and Installation -========================= - -Please find detailed :ref:`download and installation instructions -<installation>` in the manual. - -Support -======= - -If you have problems installing the software or questions about usage, -documentation or anything else related to NiBabel, you can post to the NiPy -mailing list. - -:Mailing list: neuroimaging@python.org [subscription_, archive_] - -We recommend that anyone using NiBabel subscribes to the mailing list. The -mailing list is the preferred way to announce changes and additions to the -project. You can also search the mailing list archive using the *mailing list -archive search* located in the sidebar of the NiBabel home page. - -.. _subscription: https://mail.python.org/mailman/listinfo/neuroimaging -.. _archive: https://mail.python.org/pipermail/neuroimaging - .. include:: links_names.txt - .. toctree:: :hidden: diff --git a/nibabel/info.py b/nibabel/info.py index 063978444..268d40926 100644 --- a/nibabel/info.py +++ b/nibabel/info.py @@ -58,26 +58,40 @@ For more information on previous releases, see the `release archive`_ or `development changelog`_. +Please find detailed `download and installation instructions +<installation>`_ in the manual. + .. _current release: https://pypi.python.org/pypi/NiBabel -.. _release archive: https://github.com/nipy/NiBabel/releases .. _development changelog: https://nipy.org/nibabel/changelog.html +.. _installation: https://nipy.org/nibabel/installation.html#installation +.. _release archive: https://github.com/nipy/NiBabel/releases -Mailing List -============ +Support +======= + +If you have problems installing the software or questions about usage, +documentation or anything else related to NiBabel, you can post to the NiPy +mailing list: neuroimaging@python.org [subscription_, archive_] + +The mailing list is the preferred way to announce changes and additions to the +project. You can also search the mailing list archive using the mailing list +archive search located in the sidebar of the NiBabel home page. +We recommend that anyone using NiBabel subscribes to the mailing list. -Please send any questions or suggestions to the `neuroimaging mailing list -<https://mail.python.org/mailman/listinfo/neuroimaging>`_. +.. _subscription: https://mail.python.org/mailman/listinfo/neuroimaging +.. _archive: https://mail.python.org/pipermail/neuroimaging License ======= -NiBabel is licensed under the terms of the `MIT license -<https://github.com/nipy/nibabel/blob/master/COPYING#nibabel>`__. -Some code included with NiBabel is licensed under the `BSD license`_. -For more information, please see the COPYING_ file. +NiBabel is free-software (beer and speech) and covered by the `MIT License`_. +This applies to all source code, documentation, examples and snippets inside +the source distribution (including this website). Please see the +`appendix of the manual <license>`_ for the copyright statement and the +full text of the license. -.. _BSD license: https://opensource.org/licenses/BSD-3-Clause -.. _COPYING: https://github.com/nipy/nibabel/blob/master/COPYING +.. _license: https://nipy.org/nibabel/legal.html#license +.. _MIT License: https://opensource.org/license17s/MIT Citation ======== From 961b6110c629aa049ced0380cf25d1ffcb703bd7 Mon Sep 17 00:00:00 2001 From: Zvi Baratz <z.baratz@gmail.com> Date: Tue, 21 Feb 2023 19:15:43 +0200 Subject: [PATCH 2/5] DOC: Removed duplicate MIT license entry --- README.rst | 1 - nibabel/info.py | 1 - 2 files changed, 2 deletions(-) diff --git a/README.rst b/README.rst index e397d3cf1..6567b02ea 100644 --- a/README.rst +++ b/README.rst @@ -151,7 +151,6 @@ the source distribution (including this website). Please see the full text of the license. .. _license: https://nipy.org/nibabel/legal.html#license -.. _MIT License: https://opensource.org/license17s/MIT Citation ======== diff --git a/nibabel/info.py b/nibabel/info.py index 268d40926..f3b708f38 100644 --- a/nibabel/info.py +++ b/nibabel/info.py @@ -91,7 +91,6 @@ full text of the license. .. _license: https://nipy.org/nibabel/legal.html#license -.. _MIT License: https://opensource.org/license17s/MIT Citation ======== From 030c93d3fc6d98395840f6e5b67483e17e78cc6b Mon Sep 17 00:00:00 2001 From: Zvi Baratz <z.baratz@gmail.com> Date: Wed, 22 Feb 2023 09:11:52 +0200 Subject: [PATCH 3/5] DOC: Fixed MIT license reference --- doc/source/links_names.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/source/links_names.txt b/doc/source/links_names.txt index 7fbb27b12..438031cf3 100644 --- a/doc/source/links_names.txt +++ b/doc/source/links_names.txt @@ -48,7 +48,6 @@ .. _GPL: https://www.gnu.org/licenses/gpl.html .. _BSD: http://www.opensource.org/licenses/bsd-license.php .. _LGPL: https://www.gnu.org/copyleft/lesser.html -.. _MIT License: http://www.opensource.org/licenses/mit-license.php .. _PDDL 1.0: http://opendatacommons.org/licenses/pddl/1.0/ .. _CC0: http://opendefinition.org/licenses/cc-zero From 80d964ef3680887690c41f02b84558f88ce6247c Mon Sep 17 00:00:00 2001 From: Zvi Baratz <z.baratz@gmail.com> Date: Wed, 22 Feb 2023 09:29:50 +0200 Subject: [PATCH 4/5] DOC: Another attempt to fix MIT license link --- README.rst | 11 ++++++----- nibabel/info.py | 11 ++++++----- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 6567b02ea..d06198bbf 100644 --- a/README.rst +++ b/README.rst @@ -144,13 +144,14 @@ We recommend that anyone using NiBabel subscribes to the mailing list. License ======= -NiBabel is free-software (beer and speech) and covered by the `MIT License`_. -This applies to all source code, documentation, examples and snippets inside -the source distribution (including this website). Please see the -`appendix of the manual <license>`_ for the copyright statement and the -full text of the license. +NiBabel is free-software (beer and speech) and covered by the +`MIT License <mit>`_. This applies to all source code, documentation, +examples and snippets inside the source distribution (including this website). +Please see the `appendix of the manual <license>`_ for the copyright statement +and the full text of the license. .. _license: https://nipy.org/nibabel/legal.html#license +.. _mit: https://opensource.org/license17s/MIT Citation ======== diff --git a/nibabel/info.py b/nibabel/info.py index f3b708f38..7dac44d82 100644 --- a/nibabel/info.py +++ b/nibabel/info.py @@ -84,13 +84,14 @@ License ======= -NiBabel is free-software (beer and speech) and covered by the `MIT License`_. -This applies to all source code, documentation, examples and snippets inside -the source distribution (including this website). Please see the -`appendix of the manual <license>`_ for the copyright statement and the -full text of the license. +NiBabel is free-software (beer and speech) and covered by the +`MIT License <mit>`_. This applies to all source code, documentation, +examples and snippets inside the source distribution (including this website). +Please see the `appendix of the manual <license>`_ for the copyright statement +and the full text of the license. .. _license: https://nipy.org/nibabel/legal.html#license +.. _mit: https://opensource.org/license17s/MIT Citation ======== From df741f3ab046e509555c57a577d4c2b68c0d3f3e Mon Sep 17 00:00:00 2001 From: Zvi Baratz <z.baratz@gmail.com> Date: Thu, 13 Apr 2023 11:30:47 +0300 Subject: [PATCH 5/5] Changed info.py URLs to use relative addresses --- nibabel/info.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/nibabel/info.py b/nibabel/info.py index 7dac44d82..9e64cc318 100644 --- a/nibabel/info.py +++ b/nibabel/info.py @@ -22,7 +22,7 @@ and image data is made available via NumPy arrays. For more information, see NiBabel's `documentation site`_ and `API reference`_. -.. _API reference: https://nipy.org/nibabel/api.html +.. _API reference: ./api.html .. _AFNI BRIK/HEAD: https://afni.nimh.nih.gov/pub/dist/src/README.attributes .. _ANALYZE: http://www.grahamwideman.com/gw/brain/analyze/formatdoc.htm .. _CIFTI-2: https://www.nitrc.org/projects/cifti/ @@ -58,12 +58,11 @@ For more information on previous releases, see the `release archive`_ or `development changelog`_. -Please find detailed `download and installation instructions -<installation>`_ in the manual. +Please find detailed `download and installation instructions`_ in the manual. .. _current release: https://pypi.python.org/pypi/NiBabel -.. _development changelog: https://nipy.org/nibabel/changelog.html -.. _installation: https://nipy.org/nibabel/installation.html#installation +.. _development changelog: ./changelog.html +.. _download and installation instructions: ./installation.html#installation .. _release archive: https://github.com/nipy/NiBabel/releases Support @@ -90,7 +89,7 @@ Please see the `appendix of the manual <license>`_ for the copyright statement and the full text of the license. -.. _license: https://nipy.org/nibabel/legal.html#license +.. _license: ./legal.html#license .. _mit: https://opensource.org/license17s/MIT Citation