Merge branch '264-test-documentation-with-doctest-usage-guide-is-brok…

…en-for-version-1x' into develop
cleder · Nov 27, 2023 · 40bf140 · 40bf140
2 parents 6a915ea + 9610daf
commit 40bf140
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 28 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -78,10 +78,6 @@ repos:
     hooks:
       - id: mypy
         additional_dependencies: [pygeoif, arrow]
-  # - repo: https://github.com/mgedmin/check-manifest
-  #   rev: "0.49"
-  #   hooks:
-  #     - id: check-manifest
   # - repo: https://github.com/Lucas-C/pre-commit-hooks-markup
   #   rev: v1.0.1
   #   hooks:

diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/README.rst b/README.rst
@@ -1,8 +1,7 @@
 Introduction
 ============
 
-KML is an XML geospatial data format and an `OGC standard <https://www.ogc.org/search/content/kml>`_
-that deserves a canonical python implementation.
+KML is an XML geospatial data format and an OGC_ standard that deserves a canonical python implementation.
 
 Fastkml is a library to read, write and manipulate KML files. It aims to keep
 it simple and fast (using lxml_ if available). Fast refers to the time you
@@ -97,18 +96,14 @@ Requirements
 -------------
 
 * pygeoif_
-* lxml_
 * arrow_
 
 Optional
 ---------
 
-* lxml_
-
-You can install all of the requirements for working with FastKML by using pip_::
-
-    pip install -r requirements.txt
+* lxml_::
 
+    pip install --pre "fastkml[lxml]"
 
 Limitations
 ===========
@@ -122,7 +117,7 @@ is the `gx extension
 <https://developers.google.com/kml/documentation/kmlreference#kmlextensions>`_.
 Please submit a PR with the features you'd like to see implemented.
 
-.. _pygeoif: http://pypi.python.org/pypi/pygeoif/
+.. _pygeoif: https://pypi.python.org/pypi/pygeoif/
 .. _lxml: https://pypi.python.org/pypi/lxml
 .. _arrow: https://pypi.python.org/pypi/arrow
-.. _pip: https://pypi.python.org/pypi/pip
+.. _OGC: https://www.ogc.org/standard/kml/
diff --git a/docs/HISTORY.txt → docs/HISTORY.rst b/docs/HISTORY.txt → docs/HISTORY.rst
@@ -9,7 +9,8 @@ Changelog
 - Drop shapely native support
 - Add type annotations
 - refactor
-
+- Use arrow instead of dateutil
+- Add an informative ``__repr__``
 
 0.12 (2020/09/23)
 -----------------

diff --git a/docs/conf.py b/docs/conf.py
@@ -28,7 +28,10 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.autodoc"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

diff --git a/docs/fastkml.rst b/docs/fastkml.rst
@@ -100,6 +100,7 @@ fastkml.kml module
    :members:
    :undoc-members:
    :show-inheritance:
+   :no-index: StyleUrl
 
 fastkml.mixins module
 ---------------------

diff --git a/fastkml/about.py b/fastkml/about.py
@@ -3,4 +3,4 @@
 
 The only purpose of this module is to provide a version number for the package.
 """
-__version__ = "1.0.a8"
+__version__ = "1.0.a9"
diff --git a/fastkml/py.typed b/fastkml/py.typed
diff --git a/pyproject.toml b/pyproject.toml
@@ -94,6 +94,7 @@ keywords = [
 ]
 
 [project.urls]
+Changelog = "https://github.com/cleder/fastkml/blob/develop/docs/HISTORY.rst"
 Documentation = "https://fastkml.readthedocs.org/"
 Homepage = "https://github.com/cleder/fastkml"
 
@@ -106,6 +107,15 @@ ignore = [
     "tox.ini",
 ]
 
+[tool.coverage.paths]
+source = [
+    "fastkml",
+    "tests",
+]
+
+[tool.coverage.run]
+branch = true
+
 [tool.flake8]
 max_line_length = 89
 
@@ -242,6 +252,10 @@ attr = "fastkml.about.__version__"
 
 [tool.setuptools.packages.find]
 exclude = [
-    "ez_setup",
+    "docs/*",
+]
+include = [
+    "fastkml*",
+    "fastkml/py.typed",
 ]
 namespaces = false