Skip to content

Commit

Permalink
DOC: replace pygeos -> shapely in the reference docs (#1394)
Browse files Browse the repository at this point in the history
  • Loading branch information
jorisvandenbossche committed May 22, 2022
1 parent 43f75e4 commit 590a2bd
Show file tree
Hide file tree
Showing 12 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Expand Up @@ -233,7 +233,7 @@
'numpy': ('https://numpy.org/doc/stable/', None),
}

# set an environment variable for pygeos.decorators.requires_geos to see if we
# set an environment variable for shapely.decorators.requires_geos to see if we
# are in a doc build
import os
os.environ["SPHINX_DOC_BUILD"] = "1"
2 changes: 1 addition & 1 deletion docs/constructive.rst
@@ -1,7 +1,7 @@
Constructive operations
=======================

.. automodule:: pygeos.constructive
.. automodule:: shapely.constructive
:members:
:exclude-members: BufferCapStyles, BufferJoinStyles, minimum_rotated_rectangle
:special-members:
Expand Down
2 changes: 1 addition & 1 deletion docs/coordinates.rst
@@ -1,7 +1,7 @@
Coordinate operations
=====================

.. automodule:: pygeos.coordinates
.. automodule:: shapely.coordinates
:members:
:undoc-members:
:special-members:
Expand Down
2 changes: 1 addition & 1 deletion docs/creation.rst
@@ -1,7 +1,7 @@
Geometry creation
=================

.. automodule:: pygeos.creation
.. automodule:: shapely.creation
:members:
:exclude-members:
:special-members:
Expand Down
2 changes: 1 addition & 1 deletion docs/geometry.rst
Expand Up @@ -70,7 +70,7 @@ Properties
Geometry objects have neither properties nor methods.
Instead, use the functions listed below to obtain information about geometry objects.

.. automodule:: pygeos.geometry
.. automodule:: shapely.geometry
:members:
:exclude-members: GeometryType
:special-members:
Expand Down
2 changes: 1 addition & 1 deletion docs/io.rst
@@ -1,7 +1,7 @@
Input/Output
============

.. automodule:: pygeos.io
.. automodule:: shapely.io
:members:
:exclude-members:
:special-members:
Expand Down
2 changes: 1 addition & 1 deletion docs/linear.rst
@@ -1,7 +1,7 @@
Linestring operations
=====================

.. automodule:: pygeos.linear
.. automodule:: shapely.linear
:members:
:undoc-members:
:special-members:
Expand Down
2 changes: 1 addition & 1 deletion docs/measurement.rst
@@ -1,7 +1,7 @@
Measurement
===========

.. automodule:: pygeos.measurement
.. automodule:: shapely.measurement
:members:
:exclude-members:
:special-members:
Expand Down
2 changes: 1 addition & 1 deletion docs/predicates.rst
@@ -1,7 +1,7 @@
Predicates
==========

.. automodule:: pygeos.predicates
.. automodule:: shapely.predicates
:members:
:undoc-members:
:special-members:
Expand Down
2 changes: 1 addition & 1 deletion docs/set_operations.rst
@@ -1,7 +1,7 @@
Set operations
==============

.. automodule:: pygeos.set_operations
.. automodule:: shapely.set_operations
:members:
:exclude-members:
:special-members:
Expand Down
2 changes: 1 addition & 1 deletion docs/strtree.rst
@@ -1,6 +1,6 @@
STRTree
=======

.. automodule:: pygeos.strtree
.. automodule:: shapely.strtree
:members: STRtree
:exclude-members: BinaryPredicate
6 changes: 3 additions & 3 deletions docs/testing.rst
@@ -1,12 +1,12 @@
Testing
=======

The functions in this module are not directly importable from the root ``pygeos`` module.
The functions in this module are not directly importable from the root ``shapely`` module.
Instead, import them from the submodule as follows:

>>> from pygeos.testing import assert_geometries_equal
>>> from shapely.testing import assert_geometries_equal

.. automodule:: pygeos.testing
.. automodule:: shapely.testing
:members:
:exclude-members:
:special-members:
Expand Down

0 comments on commit 590a2bd

Please sign in to comment.