summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWill McGugan <willmcgugan@gmail.com>2017-10-11 07:42:47 +0100
committerGitHub <noreply@github.com>2017-10-11 07:42:47 +0100
commit7dfe14ae6c3b9c53543c1c3890232d9f37579f34 (patch)
tree67a4dc43c4263e606c5e52c4a842467a1f4c7747
parent5b5e3968b4fa12d4663fff9f800a92bbde2104ed (diff)
parent855f43de928c7c0c05073d3530f5526fe04ed6ab (diff)
downloadpyfilesystem-git-7dfe14ae6c3b9c53543c1c3890232d9f37579f34.tar.gz
Merge pull request #275 from 0x326/add-deprecation-warning-to-docsHEADmaster
Add deprecation warning to documentation
-rw-r--r--docs/index.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index ee9dc63..a7d866f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,11 +3,15 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
+.. _PyFilesystem2: https://docs.pyfilesystem.org/
+
Welcome to PyFilesystem's documentation!
========================================
PyFilesystem provides a simplified common interface to a variety of different filesystems, such as the local filesystem, zip files, ftp servers etc.
+**Note:** The project has largely been replaced by PyFilesystem2_ which offers many improvements over the original.
+
Guide
-----