Skip to content

Commit

Permalink
Updated/fixed some links in the docs
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
apdavison committed Sep 30, 2019
1 parent 45482d3 commit a9b1441
Show file tree
Hide file tree
Showing 10 changed files with 41 additions and 39 deletions.
1 change: 1 addition & 0 deletions doc/source/authors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ and may not be the current affiliation of a contributor.
* Alexander Kleinjohann
* Christian Kothe
* rishidhingra@github
* Hugo van Kemenade

1. Centre de Recherche en Neuroscience de Lyon, CNRS UMR5292 - INSERM U1028 - Universite Claude Bernard Lyon 1
2. Unité de Neuroscience, Information et Complexité, CNRS UPR 3293, Gif-sur-Yvette, France
Expand Down
40 changes: 20 additions & 20 deletions doc/source/developers_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ patch (see below) and attach it to the ticket.

To keep track of changes to the code and to tickets, you can register for
a GitHub account and then set to watch the repository at `GitHub Repository`_
(see https://help.github.com/articles/watching-repositories/).
(see https://help.github.com/en/articles/watching-and-unwatching-repositories).

Requirements
------------
Expand All @@ -58,13 +58,13 @@ Getting the source code
We use the Git version control system. The best way to contribute is through
GitHub_. You will first need a GitHub account, and you should then fork the
repository at `GitHub Repository`_
(see http://help.github.com/fork-a-repo/).
(see http://help.github.com/en/articles/fork-a-repo).

To get a local copy of the repository::

$ cd /some/directory
$ git clone [email protected]:<username>/python-neo.git

Now you need to make sure that the ``neo`` package is on your PYTHONPATH.
You can do this either by installing Neo::

Expand Down Expand Up @@ -194,7 +194,7 @@ You can then push your changes to your online repository on GitHub::

Once you think your changes are ready to be included in the main Neo repository,
open a pull request on GitHub
(see https://help.github.com/articles/using-pull-requests).
(see https://help.github.com/en/articles/about-pull-requests).


Python version
Expand Down Expand Up @@ -264,7 +264,7 @@ Michael Denker and Julia Sprenger have the necessary permissions to do this)::

.. talk about readthedocs
.. make a release branch
Expand All @@ -277,24 +277,24 @@ See :ref:`io_dev_guide` for implementation of a new IO.



.. _Python: http://www.python.org
.. _nose: http://somethingaboutorange.com/mrl/projects/nose/
.. _Python: https://www.python.org
.. _nose: https://nose.readthedocs.io/
.. _Setuptools: https://pypi.python.org/pypi/setuptools/
.. _tox: http://codespeak.net/tox/
.. _coverage: http://nedbatchelder.com/code/coverage/
.. _`PEP 8`: http://www.python.org/dev/peps/pep-0008/
.. _coverage: https://coverage.readthedocs.io/
.. _`PEP 8`: https://www.python.org/dev/peps/pep-0008/
.. _`issue tracker`: https://github.com/NeuralEnsemble/python-neo/issues
.. _`Porting to Python 3`: http://python3porting.com/
.. _`NeuralEnsemble Google group`: http://groups.google.com/group/neuralensemble
.. _`NeuralEnsemble Google group`: https://groups.google.com/forum/#!forum/neuralensemble
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx.pocoo.org/
.. _numpy: http://numpy.scipy.org/
.. _quantities: http://pypi.python.org/pypi/quantities
.. _PEP257: http://www.python.org/dev/peps/pep-0257/
.. _PEP394: http://www.python.org/dev/peps/pep-0394/
.. _PyPI: http://pypi.python.org
.. _GitHub: http://github.com
.. _Sphinx: http://www.sphinx-doc.org/
.. _numpy: https://numpy.org/
.. _quantities: https://pypi.org/project/quantities/
.. _PEP257: https://www.python.org/dev/peps/pep-0257/
.. _PEP394: https://www.python.org/dev/peps/pep-0394/
.. _PyPI: https://pypi.org
.. _GitHub: https://github.com
.. _`GitHub Repository`: https://github.com/NeuralEnsemble/python-neo/
.. _pep8: https://pypi.python.org/pypi/pep8
.. _flake8: https://pypi.python.org/pypi/flake8/
.. _pyflakes: https://pypi.python.org/pypi/pyflakes/
.. _pep8: https://pypi.org/project/pep8/
.. _flake8: https://pypi.org/project/flake8/
.. _pyflakes: https://pypi.org/project/pyflakes/
4 changes: 2 additions & 2 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ Citation
.. _Elephant: http://neuralensemble.org/elephant
.. _G-node: http://www.g-node.org/
.. _Neuroshare: http://neuroshare.org/
.. _SpykeViewer: https://spyke-viewer.readthedocs.org/en/latest/
.. _SpykeViewer: https://spyke-viewer.readthedocs.io/en/latest/
.. _NiBabel: https://nipy.org/nibabel/
.. _PyNN: http://neuralensemble.org/PyNN
.. _quantities: http://pypi.python.org/pypi/quantities
.. _quantities: https://pypi.org/project/quantities/
.. _`NeuralEnsemble mailing list`: https://groups.google.com/forum/#!forum/neuralensemble
.. _`issue tracker`: https://github.com/NeuralEnsemble/python-neo/issues
.. _tridesclous: https://github.com/tridesclous/tridesclous
Expand Down
10 changes: 5 additions & 5 deletions doc/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ To install the latest version of Neo from the Git repository::
$ python setup.py install


.. _`Python`: http://python.org/
.. _`numpy`: http://numpy.scipy.org/
.. _`quantities`: http://pypi.python.org/pypi/quantities
.. _`pip`: http://pypi.python.org/pypi/pip
.. _`Python`: https://www.python.org/
.. _`numpy`: https://numpy.org/
.. _`quantities`: https://pypi.org/project/quantities/
.. _`pip`: https://pypi.org/project/pip/
.. _`setuptools`: http://pypi.python.org/pypi/setuptools
.. _Anaconda: https://www.continuum.io/downloads
.. _Anaconda: https://www.anaconda.com/distribution/
2 changes: 1 addition & 1 deletion doc/source/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -298,4 +298,4 @@ For more complex logging, please see the documentation for the logging_ module.
Further, the handler is only attached if there are no handlers already attached to the root logger or the :mod:`neo` logger, so adding your own logger will override the default one.
Additional functions and/or classes may get logging during bugfix releases, so code relying on particular modules not having logging may break at any time without warning.

.. _`logging`: http://docs.python.org/library/logging.html
.. _`logging`: https://docs.python.org/3/library/logging.html
4 changes: 2 additions & 2 deletions doc/source/io_developers_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,5 +105,5 @@ Here are the entire files:
.. literalinclude:: ../../neo/io/exampleio.py


.. _`mailing list`: http://groups.google.com/group/neuralensemble
.. _gin-gnode: https://web.gin.g-node.org/NeuralEnsemble/ephy_testing_data
.. _`mailing list`: https://groups.google.com/forum/#!forum/neuralensemble
.. _gin-gnode: https://gin.g-node.org/NeuralEnsemble/ephy_testing_data
2 changes: 1 addition & 1 deletion doc/source/releases/0.5.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,4 +132,4 @@ Other changes
.. https://github.com/NeuralEnsemble/python-neo/issues?utf8=✓&q=is%3Aissue%20is%3Aclosed%20created%3A%3E2014-02-01%20
.. _`about the NIX format`: https://github.com/G-Node/nix/wiki
.. _`NEST simulator`: http://nest-simulator.org
.. _`NEST simulator`: https://www.nest-simulator.org/
2 changes: 1 addition & 1 deletion doc/source/releases/0.6.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Major changes:
* Introduced :mod:`neo.rawio`: a low-level reader for various data formats
* Added continuous integration for all IOs using CircleCI
(previously only :mod:`neo.core` was tested, using Travis CI)
* Moved the test file repository to https://web.gin.g-node.org/NeuralEnsemble/ephy_testing_data
* Moved the test file repository to https://gin.g-node.org/NeuralEnsemble/ephy_testing_data
- this makes it easier for people to contribute new files for testing.

Other important changes:
Expand Down
3 changes: 2 additions & 1 deletion doc/source/releases/0.8.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ Other new features
* Numpy 1.16+ compatibility
* :meth:`time_shift()` method for :class:`Epoch`/:class:`Event`/:class:`AnalogSignal`
* :meth:`time_slice()` method is now more robust
* dropped support for Python 3.4

See all `pull requests`_ included in this release and the `list of closed issues`_.

Expand All @@ -100,7 +101,7 @@ Bug fixes and improvements in IO modules
Acknowledgements
----------------

Thanks to Achileas Koutsou, Chek Yin Choi, Richard C. Gerkin,
Thanks to Achileas Koutsou, Chek Yin Choi, Richard C. Gerkin, Hugo van Kemenade,
Alexander Kleinjohann, Björn Müller, Jeffrey Gill, Christian Kothe,
Mike Sintsov, @rishidhingra, Michael Denker, Julia Sprenger, Corentin Fragnaud,
Andrew Davison and Samuel Garcia for their contributions to this release.
Expand Down
12 changes: 6 additions & 6 deletions doc/source/whatisnew.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Release notes

.. toctree::
:maxdepth: 1

releases/0.8.0.rst
releases/0.7.2.rst
releases/0.7.1.rst
Expand All @@ -14,8 +14,8 @@ Release notes
releases/0.5.2.rst
releases/0.5.1.rst
releases/0.5.0.rst



.. releases/0.2.0.rst
.. releases/0.2.1.rst
Expand Down Expand Up @@ -76,8 +76,8 @@ Version 0.2.1
* added :func:`time_slice()` method to the :class:`SpikeTrain` and :class:`AnalogSignalArray` classes.
* improvements to annotation data type handling
* added PickleIO, allowing saving Neo objects in the Python pickle format.
* added ElphyIO (see http://www.unic.cnrs-gif.fr/software.html)
* added BrainVisionIO (see http://www.brainvision.com/)
* added ElphyIO (see http://neuro-psi.cnrs.fr/spip.php?article943)
* added BrainVisionIO (see https://brainvision.com/)
* improvements to PlexonIO
* added :func:`merge()` method to the :class:`Block` and :class:`Segment` classes
* development was mostly moved to GitHub, although the issue tracker is still at neuralensemble.org/neo
Expand All @@ -99,4 +99,4 @@ New features compared to neo 0.1:



.. _quantities: http://pypi.python.org/pypi/quantities
.. _quantities: https://pypi.org/project/quantities/

0 comments on commit a9b1441

Please sign in to comment.