feat(docs): publish documentation

[TimMenninger]

Creates an api_reference.rst file to expose the existing documentation for the few functions that have docstrings, as well as add documentation for AddrInfoType and SocketFactoryType. Now, these can be properly pointed to by other projects' documentation.

What do these changes do?

Publish documentation so it can be pointed to by other projects.

Are there changes in behavior for the user?

No.

Related issue number

N/A

Checklist

• I think the code is well written
• Unit tests for the changes exist
• Documentation reflects the changes

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (17d5e48) to head (1e3e784).

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #149   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            5         5           
  Lines          250       250           
  Branches        53        53           
=========================================
  Hits           250       250           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[bdraco]

Thanks. Traveling this week. I'll take a look when I get back home and at my desk

[bdraco]

close/reopen to re-run CI

[bdraco]

Thanks @TimMenninger

[bdraco]

I fixed the RTD build so a preview can be seen here https://aiohappyeyeballs--149.org.readthedocs.build/en/149/

[bdraco]

Thanks @TimMenninger

[webknjaz]

FWIW, the generated document is typically gitignored with such extensions.

[bdraco]

FWIW, the generated document is typically gitignored with such extensions.

I'm not following. Are you suggesting to ignore ./_build/html/api_reference.html and ./_build/doctrees/api_reference.doctree AFAICT everything in _build should already be ignored

aiohappyeyeballs/.gitignore

Line 74 in 36149e7

docs/_build/

?