You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by li...@apache.org on 2022/04/05 12:46:04 UTC

[arrow] branch master updated: MINOR: [Docs] Replace old filesystem docs with reference to new location

This is an automated email from the ASF dual-hosted git repository.

lidavidm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git


The following commit(s) were added to refs/heads/master by this push:
     new e92c775645 MINOR: [Docs] Replace old filesystem docs with reference to new location
e92c775645 is described below

commit e92c77564592fadc0d8e6a34964f79d26b9448d4
Author: Will Jones <wi...@gmail.com>
AuthorDate: Tue Apr 5 08:45:50 2022 -0400

    MINOR: [Docs] Replace old filesystem docs with reference to new location
    
    The old docs were oddly formatted: https://arrow.apache.org/docs/python/api/files.html#file-systems
    ![Screen Shot 2022-04-04 at 10 50 05 AM](https://user-images.githubusercontent.com/5488879/161602133-9c967bc3-480b-4b4d-8a23-6cf084577b13.png)
    
    The legacy filesystem stuff already has API docs on [this other page](https://arrow.apache.org/docs/python/filesystems_deprecated.html), so we aren't losing anything by deleting the stuff on `files.rst`.
    
    Closes #12792 from wjones127/docs-minor
    
    Authored-by: Will Jones <wi...@gmail.com>
    Signed-off-by: David Li <li...@gmail.com>
---
 docs/source/python/api/files.rst       | 9 +--------
 docs/source/python/api/filesystems.rst | 4 ++--
 2 files changed, 3 insertions(+), 10 deletions(-)

diff --git a/docs/source/python/api/files.rst b/docs/source/python/api/files.rst
index 106dfde8ab..d9da2b70f7 100644
--- a/docs/source/python/api/files.rst
+++ b/docs/source/python/api/files.rst
@@ -55,11 +55,4 @@ Stream Classes
 File Systems
 ------------
 
-.. autosummary::
-   :toctree: ../generated/
-
-   hdfs.connect
-   LocalFileSystem
-
-.. class:: HadoopFileSystem
-   :noindex:
+See :ref:`api.fs`.
diff --git a/docs/source/python/api/filesystems.rst b/docs/source/python/api/filesystems.rst
index 2173c96258..f84a3e229c 100644
--- a/docs/source/python/api/filesystems.rst
+++ b/docs/source/python/api/filesystems.rst
@@ -17,11 +17,11 @@
 
 .. currentmodule:: pyarrow.fs
 
+.. _api.fs:
+
 Filesystems
 ===========
 
-.. _api.fs:
-
 Interface
 ---------