Merge pull request #101 from dh-tech/feature/rename-formatter-converter

Rename formatters submodule and classes to converters
dh-tech · Nov 8, 2024 · ee26ed1 · ee26ed1
2 parents 2b26e45 + 37d8623
commit ee26ed1
Show file tree

Hide file tree

Showing 26 changed files with 398 additions and 286 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -86,4 +86,4 @@
 }
 
 # turn on relative links; make sure both github and sphinx links work
-myst_enable_extensions = ["linkify"]
+# myst_enable_extensions = ["linkify"]  # disabling because not found
diff --git a/docs/index.rst b/docs/index.rst
@@ -9,7 +9,7 @@ undate documentation
    :caption: Contents:
 
    readme
-   undate
+   undate/index
    CONTRIBUTING
    DEVELOPER_NOTES
    CONTRIBUTORS

diff --git a/docs/undate.rst b/docs/undate.rst
diff --git a/docs/undate/converters.rst b/docs/undate/converters.rst
@@ -0,0 +1,30 @@
+Converters
+==========
+
+.. automodule:: undate.converters.base
+   :members:
+   :undoc-members:
+
+ISO8601
+-------
+
+.. automodule:: undate.converters.iso8601
+   :members:
+   :undoc-members:
+
+Extended Date-Time Format (EDTF)
+--------------------------------
+
+.. automodule:: undate.converters.edtf.converter
+   :members:
+   :undoc-members:
+
+.. automodule:: undate.converters.edtf.parser
+   :members:
+   :undoc-members:
+
+.. transformer is more of an internal, probably doesn't make sense to include
+.. .. automodule:: undate.converters.edtf.transformer
+..    :members:
+..    :undoc-members:
+
diff --git a/docs/undate/core.rst b/docs/undate/core.rst
@@ -0,0 +1,22 @@
+Undate objects
+==============
+
+undates and undate intervals
+------------------------------
+
+.. autoclass:: undate.undate.Undate
+   :members:
+
+.. autoclass:: undate.undate.UndateInterval
+   :members:
+
+date, timedelta, and date precision
+-----------------------------------
+
+.. autoclass:: undate.date.Date
+   :members:
+
+.. autoclass:: undate.date.Timedelta
+   :members:
+
+.. autoclass:: undate.date.DatePrecision
diff --git a/docs/undate/index.rst b/docs/undate/index.rst
@@ -0,0 +1,9 @@
+API documentation
+=================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   core
+   converters