Skip to content

WIP: Pre release doc cleanup #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 21 commits into from
Jul 22, 2012
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
7446873
DOC: clean up old sphinx extension machinery
matthew-brett Jul 20, 2012
f66cefa
DOC: fix section heading in fmri.utils
matthew-brett Jul 20, 2012
f2c0fba
DOC: fix plot commands in glm_spec
matthew-brett Jul 20, 2012
f0a8ced
DOC: update plots to new interfaces
matthew-brett Jul 20, 2012
7112357
DOC: update dependencies for sphinx doc build
matthew-brett Jul 21, 2012
bf238c1
DOC: add nipy github repo to side bar
matthew-brett Jul 21, 2012
5d7f558
DOC: update some links
matthew-brett Jul 21, 2012
e3f492c
DOC: rewrite README file, rename to .rst
matthew-brett Jul 21, 2012
515f497
DOC: update date in LICENSE
matthew-brett Jul 21, 2012
2287b5b
DOC: update THANKS and AUTHOR
matthew-brett Jul 21, 2012
f755656
DOC: move install into documentation tree
matthew-brett Jul 21, 2012
c6b4dc1
DOC: point to collated data installation page
matthew-brett Jul 21, 2012
fdd6824
DOC: add InTemporaryDirectory instructions
matthew-brett Jul 22, 2012
06e66ca
DOC: typos and whitespace in labs documentation
matthew-brett Jul 22, 2012
83ff905
DOC: harmonize README and info.py
matthew-brett Jul 22, 2012
0e5a96d
DOC: refactoring coordinate map discussion
matthew-brett Jul 22, 2012
583a687
DOC: add links back to installation page
matthew-brett Jul 22, 2012
b619036
DOC: refactor ipython to doctests in basic_io
matthew-brett Jul 22, 2012
5739ef2
DOC: small reformatting for glm_spec tutorial
matthew-brett Jul 22, 2012
4f59d44
DOC: minor cleanups to user part of docs
matthew-brett Jul 22, 2012
60d6646
DOC: move software_design to code_discussions
matthew-brett Jul 22, 2012
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
DOC: clean up old sphinx extension machinery
We were carrying old copy of sphinx extensions.  They are now all in
Debian stable (squeeze) which is soon to be replaced by Debian Wheezy,
so time to drop the old extension code.

Switch from matplotib 'htmlonly' directive to sphinx's own 'only'
directive.
  • Loading branch information
matthew-brett committed Jul 21, 2012
commit 74468738c7458fc1d562714619383d3ea155a27c
2 changes: 1 addition & 1 deletion doc/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
API
#####

.. htmlonly::
.. only:: html

:Release: |version|
:Date: |today|
Expand Down
46 changes: 9 additions & 37 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,44 +34,15 @@
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.pngmath',
'sphinx.ext.autosummary',
'ipython_console_highlighting',
'inheritance_diagram',
'inheritance_diagram',
'numpy_ext.numpydoc',
'matplotlib.sphinxext.plot_directive',
]

# Current version (as of 11/2010) of numpydoc is only compatible with sphinx >
# 1.0. We keep copies of this version in 'numpy_ext'. For a while we will also
# keep a copy of the older numpydoc version to allow compatibility with sphinx
# 0.6
try:
# With older versions of sphinx, this causes a crash
import numpy_ext.numpydoc
except ImportError:
# Older version of sphinx
extensions.append('numpy_ext_old.numpydoc')
else: # probably sphinx >= 1.0
extensions.append('numpy_ext.numpydoc')
autosummary_generate=True

# Matplotlib sphinx extensions
# ----------------------------

# Currently we depend on some matplotlib extentions that are only in
# the trunk, so we've added copies of these files to fall back on,
# since most people install releases. Once theses extensions have
# been released for a while we should remove this hack. I'm assuming
# any modifications to these extensions will be done upstream in
# matplotlib! The matplotlib trunk will have more bug fixes and
# feature updates so we'll try to use that one first.
try:
import matplotlib.sphinxext
extensions.append('matplotlib.sphinxext.mathmpl')
extensions.append('matplotlib.sphinxext.only_directives')
extensions.append('matplotlib.sphinxext.plot_directive')
except ImportError:
extensions.append('mathmpl')
extensions.append('only_directives')
extensions.append('plot_directive')
# Autosummary on
autosummary_generate=True

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand All @@ -84,8 +55,9 @@

# General substitutions.
project = 'nipy'
#copyright = ':ref:`2005-2010, Neuroimaging in Python team. <nipy-software-license>`'
copyright = '2005-2010, Neuroimaging in Python team'

#copyright = ':ref:`2005-2010, Neuroimaging in Python team. <nipy-software-license>`'
copyright = '2005-2012, Neuroimaging in Python team'

# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
Expand Down
2 changes: 1 addition & 1 deletion doc/devel/guidelines/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Development Guidelines
========================

.. htmlonly::
.. only:: html

:Release: |version|
:Date: |today|
Expand Down
2 changes: 1 addition & 1 deletion doc/devel/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Developer Guide
=================

.. htmlonly::
.. only:: html

:Release: |version|
:Date: |today|
Expand Down
2 changes: 1 addition & 1 deletion doc/devel/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Developer installs for different distributions
================================================

.. htmlonly::
.. only:: html

:Release: |version|
:Date: |today|
Expand Down
2 changes: 1 addition & 1 deletion doc/devel/planning/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Development Planning
======================

.. htmlonly::
.. only:: html

:Release: |version|
:Date: |today|
Expand Down
2 changes: 1 addition & 1 deletion doc/devel/software_design/comparisons/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Software Design
=================

.. htmlonly::
.. only:: html

:Release: |version|
:Date: |today|
Expand Down
2 changes: 1 addition & 1 deletion doc/devel/software_design/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Software Design
=================

.. htmlonly::
.. only:: html

:Release: |version|
:Date: |today|
Expand Down
2 changes: 1 addition & 1 deletion doc/devel/tools/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Developer Tools
=================

.. htmlonly::
.. only:: html

:Release: |version|
:Date: |today|
Expand Down
4 changes: 2 additions & 2 deletions doc/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
NIPY documentation
====================

.. htmlonly::
.. only:: html

:Release: |version|
:Date: |today|
Expand All @@ -24,7 +24,7 @@
publications
license

.. htmlonly::
.. only:: html

* :ref:`genindex`
* :ref:`modindex`
Expand Down
6 changes: 3 additions & 3 deletions doc/faq/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
FAQ
=====

.. htmlonly::
.. only:: html

:Release: |version|
:Date: |today|
Expand All @@ -15,5 +15,5 @@
:maxdepth: 2

why
licensing
documentation_faq
licensing
documentation_faq
16 changes: 4 additions & 12 deletions doc/sphinxext/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,11 @@ Thesea are a few sphinx extensions we are using to build the nipy
documentation. In this file we list where they each come from, since we intend
to always push back upstream any modifications or improvements we make to them.

It's worth noting that some of these are being carried (as copies) by more
than one project. Hopefully once they mature a little more, they will be
incorproated back into sphinx itself, so that all projects can use a common
base.

* From matploltlib:
* inheritance_diagram.py
* ipython_console_highlighting.py
* mathmpl.py
* only_directives.py
* plot_directive.py

* From numpy:
* docscrape.py
* docscrape_sphinx.py
* numpydoc.py
* numpy_ext

* From ipython
* ipython_console_highlighting
Loading