Doc: Python: move all docs beneath doc/source/api/python

rouault · Nov 12, 2024 · 8d57945 · 8d57945
1 parent e6ae79a
commit 8d57945
Show file tree

Hide file tree

Showing 12 changed files with 39 additions and 27 deletions.
diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst
@@ -81,18 +81,9 @@ API
    ----------
 
    .. toctree::
-       :maxdepth: 1
+       :maxdepth: 2
 
-       python_bindings
-       python/osgeo
-       python/raster_api
-       python/vector_api
-       python/spatial_ref_api
-       python/mdim_api
-       python/utilities
-       python/general
-       python_gotchas
-       python_samples
+       python/index
 
 
    `Java API <../java/index.html>`_

diff --git a/doc/source/api/python/general.rst b/doc/source/api/python/general.rst
@@ -5,8 +5,8 @@
 
 .. _python_general:
 
-Python General API
-==================
+General API
+===========
 
 Configuration Management
 ------------------------

diff --git a/doc/source/api/python/index.rst b/doc/source/api/python/index.rst
@@ -0,0 +1,21 @@
+.. _python_api:
+
+================================================================================
+Python API
+================================================================================
+
+.. only:: not latex
+
+   .. toctree::
+       :maxdepth: 2
+
+       python_bindings
+       osgeo
+       raster_api
+       vector_api
+       spatial_ref_api
+       mdim_api
+       utilities
+       general
+       python_gotchas
+       python_samples
diff --git a/doc/source/api/python/mdim_api.rst b/doc/source/api/python/mdim_api.rst
@@ -5,8 +5,8 @@
 
 .. _python_mdim_api:
 
-Python Multi-dimensional array API
-==================================
+Multi-dimensional array API
+===========================
 
 .. autoclass:: osgeo.gdal.Group
     :members:

diff --git a/doc/source/api/python/osgeo.rst b/doc/source/api/python/osgeo.rst
@@ -1,7 +1,7 @@
 .. _python_osgeo:
 
-GDAL Python submodules
-======================
+Submodules
+==========
 
 
 Submodules

diff --git a/doc/source/api/python_bindings.rst → doc/source/api/python/python_bindings.rst b/doc/source/api/python_bindings.rst → doc/source/api/python/python_bindings.rst
diff --git a/doc/source/api/python_gotchas.rst → doc/source/api/python/python_gotchas.rst b/doc/source/api/python_gotchas.rst → doc/source/api/python/python_gotchas.rst
@@ -1,7 +1,7 @@
 .. _python_gotchas:
 
 ================================================================================
-Python Gotchas in the GDAL and OGR Python Bindings
+Gotchas in the GDAL and OGR Python Bindings
 ================================================================================
 
 This page lists aspects of GDAL's and OGR's Python bindings that may catch Python programmers by surprise.

diff --git a/doc/source/api/python_samples.rst → doc/source/api/python/python_samples.rst b/doc/source/api/python_samples.rst → doc/source/api/python/python_samples.rst
@@ -1,7 +1,7 @@
 .. _python_samples:
 
 ================================================================================
-Python Sample scripts
+Sample scripts
 ================================================================================
 
 The following are sample scripts intended to give an idea how to use the

diff --git a/doc/source/api/python/raster_api.rst b/doc/source/api/python/raster_api.rst
@@ -5,8 +5,8 @@
 
 .. _python_raster_api:
 
-Python Raster API
-=================
+Raster API
+==========
 
 This page contains classes, methods, functions that relate to the GDAL :ref:`raster_data_model`:
 

diff --git a/doc/source/api/python/spatial_ref_api.rst b/doc/source/api/python/spatial_ref_api.rst
@@ -5,8 +5,8 @@
 
 .. _python_spatial_ref_api:
 
-Python Spatial Reference System API
-===================================
+Spatial Reference System API
+============================
 
 This page contains classes, methods and functions that relate to spatial reference systems:
 

diff --git a/doc/source/api/python/utilities.rst b/doc/source/api/python/utilities.rst
@@ -5,8 +5,8 @@
 
 .. _python_utilities:
 
-Python Utilities
-================
+Utilities API
+=============
 
 Raster Utilities
 ----------------

diff --git a/doc/source/api/python/vector_api.rst b/doc/source/api/python/vector_api.rst
@@ -5,8 +5,8 @@
 
 .. _python_vector_api:
 
-Python Vector API
-=================
+Vector API
+==========
 
 This page contains classes, methods, functions that relate to the GDAL :ref:`vector_data_model`. The :py:class:`Driver` and :py:class:`Dataset` classes, which applies to both vector and raster data, are documented with the :ref:`python_raster_api`.