Skip to content

Commit fabaa03

Browse files
committed
doc: cleanup doc building and updated funding info
1 parent a3ffceb commit fabaa03

8 files changed

+36
-113
lines changed

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ test: clean test-code
6666

6767
html:
6868
@echo "building docs"
69-
make -C doc clean html
69+
make -C doc clean htmlonly
7070

7171
specs:
7272
@echo "Checking specs and autogenerating spec tests"

THANKS.rst

+10-90
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,22 @@
11
.. -*- mode: rst -*-
22
3-
43
Code contributors
54
-----------------
6-
Contributors to Nipype include but are not limited to:
7-
8-
.. hlist::
95

10-
* Aimi Watanabe
11-
* Alexander Schaefer
12-
* Alexandre Gramfort
13-
* Alexandre Savio
14-
* Anisha Keshavan
15-
* Ariel Rokem
16-
* Ben Acland
17-
* Ben Cipollini
18-
* Basile Pinsard
19-
* Brendan Moloney
20-
* Brian Cheung
21-
* Charl Linssen
22-
* Chris Filo Gorgolewski
23-
* Chris Steele
24-
* Christian Haselgrove
25-
* Christopher Burns
26-
* Cindee Madison
27-
* Claire Tarbert
28-
* Colin Buchanan
29-
* Daniel Ginsburg
30-
* Daniel Haehn
31-
* Daniel Margulies
32-
* Dav Clark
33-
* David Welch
34-
* Drew Erickson
35-
* Erik Kastman
36-
* Félix C. Morency
37-
* Gael Varoquaux
38-
* Hans Johnson
39-
* Janosch Linkersdörfer
40-
* Januzz
41-
* Jarrod Millman
42-
* Jeff Lai
43-
* Jessica Forbes
44-
* John Salvatore
45-
* Lijie Huang
46-
* Michael Hallquist
47-
* Michael Hanke
48-
* Michael Notter
49-
* Michael Waskom
50-
* Nolan Nichols
51-
* Oliver Hinds
52-
* Oscar Esteban
53-
* Rosalia Tungaraza
54-
* Satrajit Ghosh
55-
* Sharad Sikka
56-
* Stephan Gerhard
57-
* Erik Ziegler
58-
* Valentin Haenel
59-
* Xiangzhen Kong
60-
* Xu Wang
61-
* Yannick Schwartz
62-
* Yaroslav O. Halchenko
6+
See `Github contributors list <https://github.com/nipy/nipype/graphs/contributors>`__.
637

64-
For full most up to date list see `Ohloh <https://www.ohloh.net/p/nipype/contributors>`__.
8+
Funding
9+
-------
6510

66-
Other contributors
67-
------------------
11+
Nipype is currently supported by `1R01EB020740-01A1 Nipype: Dataflows for Reproducible Biomedical Research <https://projectreporter.nih.gov/project_info_description.cfm?aid=9053094>`__.
6812

69-
.. hlist::
13+
Satrajit Ghosh work on this project was partially funded by NIBIB `R03EB008673 <https://projectreporter.nih.gov/project_info_description.cfm?aid=7501200>`__ and by the `INCF <http://www.incf.org>`__ through a contract with TankThink Labs, LLC.
14+
Chris Burns was supported by NIMH grant `5R01MH081909-02 Continued Development and Maintenance of the Neuroimaging in Python Project <https://projectreporter.nih.gov/project_info_description.cfm?aid=7288112>`__. Hans Jonson was supported by
15+
`2 U54 EB005149 - 06 Core 2b Huntington's Disease - Driving Biological Project <http://projectreporter.nih.gov/project_info_description.cfm?aid=8153616>`__,
16+
`S10 RR023392 Enterprise Storage In A Collaborative Neuroimaging Environment <http://projectreporter.nih.gov/project_info_description.cfm?aid=7209718>`__,
17+
`R01 NS040068 Neurobiological Predictors of Huntington's Disease <http://projectreporter.nih.gov/project_info_description.cfm?aid=6266377>`__,
18+
and `UL1 TR000442 University of Iowa Clinical and Translational Science Program <http://projectreporter.nih.gov/project_info_description.cfm?aid=8467220>`__.
7019

71-
* Matthew Brett
72-
* Michael Castelle
73-
* Philippe Ciuciu
74-
* Yann Cointepas
75-
* Mark D'Esposito
76-
* Susan Gabrieli
77-
* Brian Hawthorne
78-
* Tim Leslie
79-
* Fernando Perez
80-
* Tyler Perrachione
81-
* Jean-Baptiste Poline
82-
* Alexis Roche
83-
* Denis Riviere
84-
* Gretchen Reynolds
85-
* Jonathan Taylor
86-
* Bertrand Thirion
87-
* Bernjamin Thyreau
88-
* Mike Trumpis
89-
* Karl Young
90-
* Tom Waite
9120

9221
We would also like to thank `JetBrains <http://www.jetbrains.com/>`__ for providing `Pycharm <http://www.jetbrains.com/pycharm/>`__ licenses.
9322

94-
Funding
95-
-------
96-
Satrajit Ghosh work on this project was partially funded by NIBIB R03 EB008673 (PI: Ghosh and Whitfield-Gabrieli) and by the `INCF <http://www.incf.org>`__ through a contract with TankThink Labs, LLC.
97-
Chris Burns was supported by NIMH grant 5R01MH081909-02 (PI: Desposito). Hans Jonson was supported by
98-
`2 U54 EB005149 - 06 Core 2b Huntington's Disease - Driving Biological Project <http://projectreporter.nih.gov/project_info_description.cfm?aid=8153616&icde=16158743&ddparam=&ddvalue=&ddsub=&cr=18&csb=PT&cs=ASC>`__,
99-
`S10 RR023392 Enterprise Storage In A Collaborative Neuroimaging Environment <http://projectreporter.nih.gov/project_info_description.cfm?aid=7209718&icde=16158552&ddparam=&ddvalue=&ddsub=&cr=1&csb=default&cs=ASC>`__,
100-
`R01 NS040068 Neurobiological Predictors of Huntington's Disease <http://projectreporter.nih.gov/project_info_description.cfm?aid=6266377&icde=16158103>`__,
101-
and `UL1 TR000442 University of Iowa Clinical and Translational Science Program <http://projectreporter.nih.gov/project_info_description.cfm?aid=8467220&icde=16159156&ddparam=&ddvalue=&ddsub=&cr=1&csb=default&cs=ASC>`__.
102-

doc/_templates/indexsidebar.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ <h3>{{ _('Links') }}</h3>
55
<li>Docs: <a href="http://nipy.org/nipype">Stable</a> · <a href="http://www.mit.edu/~satra/nipype-nightly/">Nightly</a></li>
66
<li>Code: <a href="http://github.com/nipy/nipype">Github</a> · <a href="http://github.com/nipy/nipype/issues">Bugs-Requests</a></li>
77
<li>Forum: <a href="http://neurostars.org/t/nipype">User</a> · <a href="http://projects.scipy.org/mailman/listinfo/nipy-devel">Developer</a></li>
8-
<li><a href="http://nipy.org/software/license/index.html"><img src="https://img.shields.io/pypi/l/nipype.svg" alt="License"></a> · <a href="http://nipy.org/about/funding.html">Funding</a></li>
8+
<li><a href="http://nipy.org/software/license/index.html"><img src="https://img.shields.io/pypi/l/nipype.svg" alt="License"></a> · <a href="about.html#funding">Funding</a></li>
99
<li><a href="https://travis-ci.org/nipy/nipype"><img src="https://travis-ci.org/nipy/nipype.png?branch=master" alt="travis"></a> · <a href='https://coveralls.io/r/nipy/nipype'><img src='https://coveralls.io/repos/nipy/nipype/badge.png' alt='Coverage Status' /></a></li>
1010
<li><a href="https://pypi.python.org/pypi/nipype/"><img src="https://img.shields.io/pypi/dm/nipype.svg" alt="Downloads"></a> · <a href='https://pypi.python.org/pypi/nipype/'><img src='https://img.shields.io/pypi/pyversions/nipype.svg' alt='Python Versions' /></a></li>
1111
</ul>

doc/_templates/navbar.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@
1010
<a class="navbar" href="{{pathto('index')}}">Home</a> ·
1111
<a class="navbar" href="{{pathto('quickstart')}}">Quickstart</a> ·
1212
<a class="navbar" href="{{pathto('documentation')}}">Documentation</a> ·
13-
<a class="navbar" href="{{pathto('about')}}">Citation</a> ·
14-
<a class="navbar" href="http://nipy.org">NiPy</a>
13+
<a class="navbar" href="{{pathto('about')}}">About</a> ·
14+
<a class="navbar" href="http://nipy.org">Nipy</a>
1515

doc/_templates/sidebar_versions.html

+1-11
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,14 @@ <h3>{{ _('Versions') }}</h3>
1717
<td align="left">Release</td><td align="right">Devel</td>
1818
</tr>
1919
<tr>
20-
<td align="left">0.11.0</td><td align="right">{{ version }}</td>
20+
<td align="left">{{ release }}</td><td align="right">{{ version }}</td>
2121
</tr>
2222
<tr>
2323
<td align="left"><a href="{{pathto('users/install')}}">Download</a></td>
2424
<td align="right"><a href="https://github.com/nipy/nipype">Github</a></td>
2525
</tr>
2626
</table>
2727
</div>
28-
29-
<div id="buttons">
30-
<div id="ohloh-use" style="margin-right: 25px; margin-top: -2px; float: left;">
31-
<script type="text/javascript"
32-
src="https://www.openhub.net/p/480871/widgets/project_users_logo.js">
33-
</script>
34-
</div><!-- use -->
35-
<g:plusone size="medium" annotation="none"></g:plusone>
36-
<div class="clear"></div>
37-
</div><!-- buttons container -->
3828
</div>
3929

4030

doc/about.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Citation
1414
Ghosh SS. (2011). Nipype: a flexible, lightweight and extensible neuroimaging
1515
data processing framework in Python. Front. Neuroimform. 5:13.
1616

17-
`Download`__
17+
`Download Paper`__
1818

1919
__ paper_
2020

doc/conf.py

+18-5
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,24 @@
1414

1515
import sys
1616
import os
17+
from shutil import rmtree
1718

1819
nipypepath = os.path.abspath('..')
1920
sys.path.insert(1, nipypepath)
2021

2122
import nipype
2223

24+
if not os.path.exists('users/examples'):
25+
os.mkdir('users/examples')
26+
os.system('python ../tools/make_examples.py --no-exec')
27+
28+
if os.path.exists('api/generated'):
29+
rmtree('api/generated')
30+
os.system('python ../tools/build_modref_templates.py')
31+
if os.path.exists('interfaces/generated'):
32+
rmtree('interfaces/generated')
33+
os.system('python ../tools/build_interface_docs.py')
34+
2335
# If extensions (or modules to document with autodoc) are in another directory,
2436
# add these directories to sys.path here. If the directory is relative to the
2537
# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -29,7 +41,8 @@
2941

3042
# Add any Sphinx extension module names here, as strings. They can be extensions
3143
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
32-
extensions = ['sphinx.ext.todo',
44+
extensions = ['readthedocs_ext.readthedocs',
45+
'sphinx.ext.todo',
3346
'sphinx.ext.pngmath',
3447
'sphinx.ext.inheritance_diagram',
3548
'sphinx.ext.graphviz',
@@ -40,8 +53,8 @@
4053
'numpy_ext.numpydoc',
4154
'matplotlib.sphinxext.plot_directive',
4255
'matplotlib.sphinxext.only_directives',
43-
'IPython.sphinxext.ipython_directive',
44-
'IPython.sphinxext.ipython_console_highlighting'
56+
#'IPython.sphinxext.ipython_directive',
57+
#'IPython.sphinxext.ipython_console_highlighting'
4558
]
4659

4760
# Add any paths that contain templates here, relative to this directory.
@@ -58,7 +71,7 @@
5871

5972
# General information about the project.
6073
project = u'nipype'
61-
copyright = u'2009-15, Neuroimaging in Python team'
74+
copyright = u'2009-16, Neuroimaging in Python team'
6275

6376
# The version info for the project you're documenting, acts as replacement for
6477
# |version| and |release|, also used in various other places throughout the
@@ -67,7 +80,7 @@
6780
# The short X.Y version.
6881
version = nipype.__version__
6982
# The full version, including alpha/beta/rc tags.
70-
release = version
83+
release = "0.11.0"
7184

7285
# The language for content autogenerated by Sphinx. Refer to documentation
7386
# for a list of supported languages.

examples/rsfmri_vol_surface_preprocessing_nipy.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
#!/usr/bin/env python
22
"""
3-
====================================
3+
=====================================
44
rsfMRI: ANTS, FS, FSL, NiPy, aCompCor
5-
====================================
5+
=====================================
66
77
88
A preprocessing workflow for Siemens resting state data.

0 commit comments

Comments
 (0)