Skip to content

Commit 78abd28

Browse files
committed
Merge pull request #380 from bcipolli/doc
MRG: 5 small documentation changes 1. Add 3rd party copyright notice for `six` (#375) 2. Fix openhub.net badge (#378); see issue for images. 3. Update URL to numpy's docstrings (partial #376 fix). 4. Prevent content from overflowing sidebar (discovered solving #378) 5. Make all copyright notices enclosed in greyed boxes (see image below) Currently, some copyright notices are contained in greyed boxes, others were plain text (white background, no border). Changed all to be in greyed boxes.
2 parents dd4e725 + 3cd21d4 commit 78abd28

File tree

4 files changed

+63
-23
lines changed

4 files changed

+63
-23
lines changed

COPYING

Lines changed: 56 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -128,27 +128,29 @@ In ``nibabel/externals/ordereddict.py``
128128

129129
Copied from: https://pypi.python.org/packages/source/o/ordereddict/ordereddict-1.1.tar.gz#md5=a0ed854ee442051b249bfad0f638bbec
130130

131-
Copyright (c) 2009 Raymond Hettinger
132-
133-
Permission is hereby granted, free of charge, to any person
134-
obtaining a copy of this software and associated documentation files
135-
(the "Software"), to deal in the Software without restriction,
136-
including without limitation the rights to use, copy, modify, merge,
137-
publish, distribute, sublicense, and/or sell copies of the Software,
138-
and to permit persons to whom the Software is furnished to do so,
139-
subject to the following conditions:
140-
141-
The above copyright notice and this permission notice shall be
142-
included in all copies or substantial portions of the Software.
143-
144-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
145-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
146-
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
147-
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
148-
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
149-
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
150-
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
151-
OTHER DEALINGS IN THE SOFTWARE.
131+
::
132+
133+
Copyright (c) 2009 Raymond Hettinger
134+
135+
Permission is hereby granted, free of charge, to any person
136+
obtaining a copy of this software and associated documentation files
137+
(the "Software"), to deal in the Software without restriction,
138+
including without limitation the rights to use, copy, modify, merge,
139+
publish, distribute, sublicense, and/or sell copies of the Software,
140+
and to permit persons to whom the Software is furnished to do so,
141+
subject to the following conditions:
142+
143+
The above copyright notice and this permission notice shall be
144+
included in all copies or substantial portions of the Software.
145+
146+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
147+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
148+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
149+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
150+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
151+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
152+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
153+
OTHER DEALINGS IN THE SOFTWARE.
152154

153155
mni_icbm152_t1_tal_nlin_asym_09a
154156
--------------------------------
@@ -158,6 +160,8 @@ The file ``doc/source/someone.nii.gz`` is a subsampled version of the file
158160
archive ``mni_icbm152_t1_tal_nlin_asym_09a``. The original image has the
159161
following license (where 'softwware' refers to the image):
160162

163+
::
164+
161165
Copyright (C) 1993-2004 Louis Collins, McConnell Brain Imaging Centre,
162166
Montreal Neurological Institute, McGill University.
163167

@@ -209,3 +213,34 @@ the PDDL version 1.0 available at http://opendatacommons.org/licenses/pddl/1.0/
209213

210214
is courtesy of the University of Massachusetts Medical School, also released
211215
under the PDDL.
216+
217+
218+
Six
219+
--------------------
220+
221+
In ``nibabel/externals/six.py``
222+
223+
Copied from: https://pypi.python.org/packages/source/s/six/six-1.3.0.tar.gz#md5=ec47fe6070a8a64c802363d2c2b1e2ee
224+
225+
::
226+
227+
Copyright (c) 2010-2013 Benjamin Peterson
228+
229+
Permission is hereby granted, free of charge, to any person obtaining a copy of
230+
this software and associated documentation files (the "Software"), to deal in
231+
the Software without restriction, including without limitation the rights to
232+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
233+
the Software, and to permit persons to whom the Software is furnished to do so,
234+
subject to the following conditions:
235+
236+
The above copyright notice and this permission notice shall be included in all
237+
copies or substantial portions of the Software.
238+
239+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
240+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
241+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
242+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
243+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
244+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
245+
246+

doc/source/_static/nibabel.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,8 @@ div.footer {
3131
div.body {
3232
background-color: white;
3333
}
34+
35+
.sphinxsidebarwrapper {
36+
/* don't let anything exceed sidebar boundaries */
37+
overflow: hidden;
38+
}

doc/source/_templates/indexsidebar.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ <h3>Quick links</h3>
66
<li><a href="https://mail.python.org/pipermail/neuroimaging">Mailing list archive</a></li>
77
</ul>
88

9-
<script type="text/javascript" src="https://www.ohloh.net/projects/480908/widgets/project_partner_badge"></script>
9+
<script type='text/javascript' src='https://www.openhub.net/p/nibabel/widgets/project_thin_badge?format=js'></script>
1010

1111
<h3>Search mailing list archive</h3>
1212
<script type="text/javascript">

doc/source/devel/devguide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Code Documentation
2828

2929
All documentation should be written using Numpy documentation conventions:
3030

31-
http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines#docstring-standard
31+
https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#docstring-standard
3232

3333

3434
Git Repository

0 commit comments

Comments
 (0)