Skip to content

Commit

Permalink
chore: Remove Sphinx autodoc references as they are not PyPI friendly
Browse files Browse the repository at this point in the history
  • Loading branch information
mdomke committed Mar 21, 2024
1 parent 5d0c57b commit 56c7893
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ to include Pydantic support install the optional dependency like so
Basic Usage
-----------

Create a new :class:`.ULID` object from the current timestamp
Create a new ``ULID`` object from the current timestamp

.. code-block:: pycon
Expand All @@ -100,7 +100,7 @@ or use one of the named constructors
>>> ULID.from_datetime(datetime.datetime.now())
ULID(01E75J2XBK390V2XRH44EHC10X)
There are several options for encoding the :class:`.ULID` object
There are several options for encoding the ``ULID`` object
(e.g. string, hex, int, bytes, UUID):

.. code-block:: pycon
Expand All @@ -116,8 +116,8 @@ There are several options for encoding the :class:`.ULID` object
>>> ulid.to_uuid()
UUID('015ea15f-6cd1-c566-89a3-73fab3f63ece')
It is also possible to directly access the timestamp component of a :class:`.ULID`,
either in UNIX epoch or as :class:`datetime.datetime`
It is also possible to directly access the timestamp component of a ``ULID``,
either in UNIX epoch or as ``datetime.datetime``

.. code-block:: pycon
Expand All @@ -133,7 +133,7 @@ either in UNIX epoch or as :class:`datetime.datetime`
Pydantic integration
---------------------

The :class:`.ULID` class can be directly used for the popular data validation library
The ``ULID`` class can be directly used for the popular data validation library
`Pydantic <https://docs.pydantic.dev/latest/>`_ like so

.. code-block:: python
Expand Down

0 comments on commit 56c7893

Please sign in to comment.