Merge pull request #275 from 0x326/add-deprecation-warning-to-docs

willmcgugan · web-flow · commit 7dfe14ae6c3b · 2017-10-11T07:42:47.000+01:00
Add deprecation warning to documentation
diff --git 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
 -----
 
