Skip to content

Commit

Permalink
docs: add link to supported file formats
Browse files Browse the repository at this point in the history
  • Loading branch information
paulmueller committed Feb 14, 2020
1 parent 45e72f1 commit cf3f049
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,4 +193,5 @@
"numpy": ('https://docs.scipy.org/doc/numpy', None),
"scipy": ('https://docs.scipy.org/doc/scipy/reference/', None),
"nanite": ('https://nanite.readthedocs.io/en/stable', None),
"afmformats": ('https://afmformats.readthedocs.io/en/stable', None),
}
9 changes: 8 additions & 1 deletion docs/sec_getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,14 @@ If you installed pyjibe with ``pip``, you may upgrade it with:
pip install --upgrade pyjibe
Supported file formats
======================
PyJibe relies on the :ref:`afmformats <afmformats:index>` package.
A list of supported file formats can be found
:ref:`here <afmformats:supported_formats>`.


How to cite
-----------
===========
If you use PyJibe in a scientific publication, please consider citing
Müller et al., *BMC Bioinformatics* (2019) :cite:`Mueller19nanite`.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
license="GPL v3",
description=description,
long_description=open('README.rst').read() if exists('README.rst') else '',
install_requires=["afmformats>=0.8.0",
install_requires=["afmformats>=0.9.0",
"appdirs",
"nanite>=1.4.1",
"matplotlib",
Expand Down

0 comments on commit cf3f049

Please sign in to comment.