From 342383c3ae5785fb4b3181cbb44711a387759d3d Mon Sep 17 00:00:00 2001 From: peterjc Date: Fri, 21 Sep 2018 12:02:06 +0100 Subject: [PATCH] Move sphinx-specific :doc: entry out of README.rst This ensures that README.rst is a valid standalone RST file and will render cleanly on GitHub and hopefully also PyPI. --- README.rst | 3 +-- docs/INTRO.rst | 2 ++ 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 67b5d1b..808a81d 100644 --- a/README.rst +++ b/README.rst @@ -177,5 +177,4 @@ template ``Reader`` which provides the metadata:: ... vcf_writer.write_record(record) An extensible script is available to filter vcf files in vcf_filter.py. VCF filters -declared by other packages will be available for use in this script. Please -see :doc:`FILTERS` for full description. +declared by other packages will be available for use in this script. diff --git a/docs/INTRO.rst b/docs/INTRO.rst index 2b9a587..553aaf3 100644 --- a/docs/INTRO.rst +++ b/docs/INTRO.rst @@ -2,3 +2,5 @@ Introduction ============ .. include:: ../README.rst + +Please see :doc:`FILTERS` for full description of how the filters work.