From deb2d9199e95f641580069d813b85ed97243b25d Mon Sep 17 00:00:00 2001 From: Isaac Virshup Date: Mon, 28 Jun 2021 15:42:48 +1000 Subject: [PATCH] Update dev docs + release note --- docs/dev/documentation.rst | 7 +++++-- docs/dev/external-tools.rst | 2 +- docs/release-notes/1.8.0.rst | 1 + 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/dev/documentation.rst b/docs/dev/documentation.rst index abaed6dd7..0b2b059ed 100644 --- a/docs/dev/documentation.rst +++ b/docs/dev/documentation.rst @@ -15,6 +15,10 @@ Sometimes these caches are not invalidated when you've updated the docs. If docs are not updating the way you expect, first try "force reloading" your browser page – e.g. reload the page without using the cache. Next, if problems persist, clear the sphinx cache and try building them again (`make clean` from `docs` directory). +.. note:: + If you've cloned the repository pre 1.8.0, you may need to be more thorough in cleaning. + If you run into warnings try removing all untracked files in the docs directory. + Adding to the docs ------------------ @@ -24,8 +28,7 @@ These files are found in the `docs/release-notes/` directory. We recommend waiting on this until your PR is close to done since this can often causes merge conflicts. Once you've added a new function to the documentation, you'll need to make sure there is a link somewhere in the documentation site pointing to it. -For computational methods, this should be added to `docs/index.rst` under a relevant heading. -For plotting functions, add these to the module docstring of the plotting module at `scanpy/pl/__init__.py`. +This should be added to `docs/api.rst` under a relevant heading. For tutorials and more in depth examples, consider adding a notebook to `scanpy-tutorials `__. diff --git a/docs/dev/external-tools.rst b/docs/dev/external-tools.rst index 283b01b7e..ea443046c 100644 --- a/docs/dev/external-tools.rst +++ b/docs/dev/external-tools.rst @@ -8,7 +8,7 @@ Docs ---- To make sure your tool gets an entry in the documentation, you'll have to add it. -These docs are generated from the module docstring for `sc.external`, so make sure there is a reference to your new function in `scanpy/external/__init__.py`. +Make sure there is a reference to your new function in `docs/external.rst`. Testing ------- diff --git a/docs/release-notes/1.8.0.rst b/docs/release-notes/1.8.0.rst index cdd867748..ff81ac461 100644 --- a/docs/release-notes/1.8.0.rst +++ b/docs/release-notes/1.8.0.rst @@ -53,5 +53,6 @@ - Fixed typos in grouped plot doc-strings :pr:`1877` :smaller:`C Rands` - Extended examples for differential expression plotting. :pr:`1529` :smaller:`F Ramirez` - See :func:`~scanpy.pl.rank_genes_groups_dotplot` or :func:`~scanpy.pl.rank_genes_groups_matrixplot` for examples. +- Reorganized reference docs :pr:`1753` :smaller:`I Virshup` .. _docsearch: https://docsearch.algolia.com/