Skip to content

Commit

Permalink
Update README and documentation configuration
Browse files Browse the repository at this point in the history
- Added Conda version badge to README
- Removed outdated maybe_valid description from MultiPoint section
- Included sphinx.ext.viewcode extension in docs configuration
  • Loading branch information
cleder committed Nov 21, 2024
1 parent 2b7a477 commit 6800703
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ testing with Hypothesis_.

It was written to provide clean and python only geometries for fastkml_

|doc| |test| |cov| |hypothesis| |black| |mypy| |openhub| |factor| |commit| |py| |implement| |latest| |license| |downloads|
|doc| |test| |cov| |hypothesis| |black| |mypy| |openhub| |factor| |commit| |py| |conda| |implement| |latest| |license| |downloads|

.. |doc| image:: https://readthedocs.org/projects/pygeoif/badge/?version=latest
:target: https://pygeoif.readthedocs.io/en/latest/?badge=latest
Expand Down Expand Up @@ -79,6 +79,9 @@ It was written to provide clean and python only geometries for fastkml_
.. |py| image:: https://img.shields.io/pypi/pyversions/pygeoif.svg
:target: https://pypi.python.org/pypi/pygeoif/
:alt: Supported Python versions
.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/pygeoif.svg
:target: https://anaconda.org/conda-forge/pygeoif
:alt: Conda Version

.. |implement| image:: https://img.shields.io/pypi/implementation/pygeoif.svg
:target: https://pypi.python.org/pypi/pygeoif/
Expand Down Expand Up @@ -215,11 +218,6 @@ exterior : LinearRing
The ring which bounds the positive space of the polygon.
interiors : sequence
A sequence of rings which bound all existing holes.
maybe_valid: boolean
When a polygon has obvious problems such as self crossing
lines or holes that are outside the exterior bounds this will
return False. Even if this returns True the geometry may still be invalid,
but if this returns False you do have a problem.

MultiPoint
----------
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
"sphinx.ext.doctest",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.viewcode",
]

templates_path = ["_templates"]
Expand Down

0 comments on commit 6800703

Please sign in to comment.