From 329bd4d40dd756b4bc1d1fcdb1a6b3295a357506 Mon Sep 17 00:00:00 2001 From: Philipp A Date: Thu, 5 Jul 2018 14:26:05 +0200 Subject: [PATCH] Modernized some links --- docs/api/index.rst | 3 +-- docs/basic_usage.rst | 3 +-- docs/installation.rst | 8 ++++---- docs/release_notes.rst | 11 +++++------ versioneer.py | 2 +- 5 files changed, 12 insertions(+), 15 deletions(-) diff --git a/docs/api/index.rst b/docs/api/index.rst index dd67f7ae87..e166319bd7 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -146,8 +146,7 @@ Read 10x formatted hdf5 files using read_10x_h5 -Read other formats using functions borrowed from `anndata -`_ +Read other formats using functions borrowed from :mod:`anndata` .. autosummary:: :toctree: . diff --git a/docs/basic_usage.rst b/docs/basic_usage.rst index e79a8185ac..88962d8b25 100644 --- a/docs/basic_usage.rst +++ b/docs/basic_usage.rst @@ -25,8 +25,7 @@ To facilitate writing memory-efficient pipelines, by default, Scanpy tools opera AnnData ^^^^^^^ -Scanpy is based on `anndata `_, which provides -the :class:`~anndata.AnnData` class. +Scanpy is based on :mod:`anndata`, which provides the :class:`~anndata.AnnData` class. .. raw:: html diff --git a/docs/installation.rst b/docs/installation.rst index 7bc1494df7..7602f271dd 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -7,7 +7,7 @@ Running the following installs most of the requirements:: conda install seaborn scikit-learn statsmodels numba -Pull Scanpy from `PyPI `__ (consider using ``pip3`` to access Python 3):: +Pull Scanpy from `PyPI `__ (consider using ``pip3`` to access Python 3):: pip install scanpy @@ -31,7 +31,7 @@ If you're using Docker_, you can use the minimal `fastgenomics/scanpy`_ image fr .. _Docker: https://en.wikipedia.org/wiki/Docker_(software) .. _fastgenomics/scanpy: https://hub.docker.com/r/fastgenomics/scanpy - + Trouble shooting ~~~~~~~~~~~~~~~~ @@ -45,12 +45,12 @@ If you do not have sudo rights (you get a ``Permission denied`` error):: - If python-igraph still fails to install, see `here `__ or consider installing gcc via ``brew install gcc --without-multilib`` and exporting ``export CC="/usr/local/Cellar/gcc/X.x.x/bin/gcc-X"; export CXX="/usr/local/Cellar/gcc/X.x.x/bin/gcc-X"``, where ``X`` and ``x`` refers to the version of ``gcc``; in my case, the path reads ``/usr/local/Cellar/gcc/6.3.0_1/bin/gcc-6``. **On Windows**, you can follow these steps:: - + conda install pandas cython conda install -c vtraag python-igraph conda install -c vtraag louvain pip install scanpy - + Installing Miniconda ~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 2eb80b78e7..0ce03be519 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -1,6 +1,6 @@ .. note:: - Also see the release notes of `anndata `_. + Also see the :ref:`release notes ` of :mod:`anndata`. .. role:: small @@ -141,7 +141,7 @@ Version 0.4.4 :small:`February 26, 2018` `_ [Waskom16]_ 2. only return `matplotlib.Axis` in plotting functions of ``sc.pl`` when `show=False`, otherwise `None` -... and through `anndata v0.5 `_ +... and through :mod:`anndata` v0.5. 1. inform about duplicates in :class:`~anndata.AnnData.var_names` and resolve them using :func:`~anndata.AnnData.var_names_make_unique` 2. by default, generate unique observation names in :func:`~anndata.AnnData.concatenate` @@ -162,7 +162,7 @@ Version 0.4.4 :small:`February 26, 2018` `_, `docs `_ -... and through `anndata v0.4 `_ +... and through :mod:`anndata` v0.4. 1. towards a common file format for exchanging :class:`~anndata.AnnData` with packages such as Seurat and SCDE by reading and writing `.loom @@ -184,11 +184,10 @@ Version 0.4.4 :small:`February 26, 2018` **November 16, 2017**: version 0.3 -1. :class:`~anndata.AnnData` can be `concatenated `_ -2. :class:`~anndata.AnnData` is available as a `separate package `_ +1. :class:`~anndata.AnnData` can be :meth:`~anndata.AnnData.concatenate` d. +2. :class:`~anndata.AnnData` is available as a `separate package `_ 3. results of approximate graph abstraction (AGA) are `simplified `_ - **October 25, 2017**: version 0.2.9 Initial release of `approximate graph abstraction (AGA) `_. diff --git a/versioneer.py b/versioneer.py index a9b37557c5..70ffdcdf87 100644 --- a/versioneer.py +++ b/versioneer.py @@ -271,7 +271,7 @@ https://creativecommons.org/publicdomain/zero/1.0/ . [pypi-image]: https://img.shields.io/pypi/v/versioneer.svg -[pypi-url]: https://pypi.python.org/pypi/versioneer/ +[pypi-url]: https://pypi.org/project/versioneer/ [travis-image]: https://img.shields.io/travis/warner/python-versioneer/master.svg [travis-url]: https://travis-ci.org/warner/python-versioneer