Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename formatters submodule and classes to converters #101

Merged
merged 5 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ undate documentation
:caption: Contents:

readme
undate
undate/index
CONTRIBUTING
DEVELOPER_NOTES
CONTRIBUTORS
Expand Down
11 changes: 0 additions & 11 deletions docs/undate.rst

This file was deleted.

30 changes: 30 additions & 0 deletions docs/undate/converters.rst
Original file line number Diff line number Diff line change
@@ -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:

22 changes: 22 additions & 0 deletions docs/undate/core.rst
Original file line number Diff line number Diff line change
@@ -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
9 changes: 9 additions & 0 deletions docs/undate/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
API documentation
=================

.. toctree::
:maxdepth: 2
:caption: Contents:

core
converters
Loading
Loading