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

feat(docs): publish documentation #149

Merged
merged 1 commit into from
Mar 11, 2025
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
45 changes: 45 additions & 0 deletions docs/api_reference.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
API Reference
=============

.. autodata:: aiohappyeyeballs.AddrInfoType

A tuple representing socket address information.

Indexes:

**[0]** ``Union[int, socket.AddressFamily]``

The address family, e.g. ``socket.AF_INET``

**[1]** ``Union[int, socket.SocketKind]``

The type of socket, e.g. ``socket.SOCK_STREAM``.

**[2]** ``int``

The protocol number, e.g. ``socket.IPPROTO_TCP``.

**[3]** ``str``

The canonical name of the address, e.g. ``"www.example.com"``.

**[4]** ``Tuple``

The socket address tuple, e.g. ``("127.0.0.1", 443)``.

.. autodata:: aiohappyeyeballs.SocketFactoryType

A callable that creates a socket from an ``AddrInfoType``.


:param AddrInfoType: Address info for creating the socket containing
the address family, socket type, protocol, host address, and
additional details.

:rtype: ``socket.socket``


.. automodule:: aiohappyeyeballs
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
# General configuration
extensions = [
"myst_parser",
"sphinx.ext.autodoc",
]

# The suffix of source filenames.
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
:caption: Installation & Usage
:maxdepth: 2

api_reference
installation
usage
```
Expand Down
Loading