Skip to content

Commit

Permalink
Drop m2r requirement now readme is rst
Browse files Browse the repository at this point in the history
  • Loading branch information
TomDonoghue committed Apr 19, 2020
1 parent ae84b15 commit d46f552
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 21 deletions.
21 changes: 9 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,25 +98,23 @@ Installation

To install the current pre-release version, use pip:

``$ pip install fooof --pre``

.. code-block:: shell
pip install fooof --pre
$ pip install fooof --pre
If you already have a version of FOOOF installed, you will need to remove it first:

.. code-block:: shell
pip uninstall fooof
$ pip uninstall fooof
**Stable Version**

To install the latest stable release, use pip:

.. code-block:: shell
pip install fooof
$ pip install fooof
Note that this will install only the core (non-optional) FOOOF requirements.

Expand All @@ -126,21 +124,21 @@ To get the current development version, first clone this repository:

.. code-block:: shell
git clone https://github.com/fooof-tools/fooof
$ git clone https://github.com/fooof-tools/fooof
To install this cloned copy, move into the directory you just cloned, and run:

.. code-block:: shell
pip install .
$ pip install .
**Editable Version**

To install an editable version, download the development version as above, and run:

.. code-block:: shell
pip install -e .
$ pip install -e .
Matlab Support
--------------
Expand All @@ -164,14 +162,13 @@ Reference
If you use this code in your project, please cite:
::
Haller M, Donoghue T, Peterson E, Varma P, Sebastian P, Gao R, Noto T, Knight RT, Shestyuk A,
Voytek B (2018) Parameterizing Neural Power Spectra. bioRxiv, 299859.
doi: https://doi.org/10.1101/299859
Voytek B (2018) Parameterizing Neural Power Spectra. bioRxiv, 299859. doi: 10.1101/299859

Direct Link: https://doi.org/10.1101/299859

More information for how to cite this method can be found on the
`reference page <https://fooof-tools.github.io/fooof/reference.html>`_.

Direct Link: https://doi.org/10.1101/299859

Code and analyses from the paper are also available in the
`paper repository <https://github.com/fooof-tools/Paper>`_.

Expand Down
2 changes: 0 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@
'sphinx.ext.viewcode',
'sphinx_gallery.gen_gallery',
'numpydoc',
'm2r'
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -63,7 +62,6 @@
autodoc_default_options = {
'members': None,
'inherited-members': None,
#'no-inherited-members': None,
}

# generate autosummary even if no references
Expand Down
1 change: 0 additions & 1 deletion doc/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Table of Contents
.. toctree::
:maxdepth: 3

readme_link.rst
api.rst
faq.rst
glossary.rst
Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@

.. mdinclude:: ../README.md
.. include:: ../README.rst
4 changes: 0 additions & 4 deletions doc/readme_link.rst

This file was deleted.

1 change: 0 additions & 1 deletion requirements-docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
sphinx
sphinx_gallery
sphinx_bootstrap_theme
m2r
numpydoc

# Optional fooof dependencies that are required for documentation
Expand Down

0 comments on commit d46f552

Please sign in to comment.