summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Meyer <0x326@users.noreply.github.com>2017-10-09 21:22:25 -0400
committerGitHub <noreply@github.com>2017-10-09 21:22:25 -0400
commita6c044de1664051ed11cd111f200f22cec009f8f (patch)
tree34edf84cbbf0f89b1d8fa7f64822511a3aabf312
parent5b5e3968b4fa12d4663fff9f800a92bbde2104ed (diff)
downloadpyfilesystem-git-a6c044de1664051ed11cd111f200f22cec009f8f.tar.gz
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..70a0c53 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://pyfilesystem2.readthedocs.io/en/latest/
+
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
-----