Skip to content

feat(docs): publish documentation#149

Merged
bdraco merged 1 commit intoaio-libs:mainfrom
TimMenninger:update-docs
Mar 11, 2025
Merged

feat(docs): publish documentation#149
bdraco merged 1 commit intoaio-libs:mainfrom
TimMenninger:update-docs

Conversation

@TimMenninger
Copy link
Copy Markdown
Contributor

@TimMenninger TimMenninger commented Mar 11, 2025 •
edited
Loading

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

@TimMenninger
docs: publish documentation
67f710f 
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.
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 11, 2025 •
edited
Loading

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.

@TimMenninger TimMenninger marked this pull request as ready for review March 11, 2025 00:45
@bdraco
Copy link
Copy Markdown
Member

bdraco commented Mar 11, 2025

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

@bdraco bdraco closed this Mar 11, 2025
@bdraco bdraco reopened this Mar 11, 2025
@bdraco
Copy link
Copy Markdown
Member

bdraco commented Mar 11, 2025

close/reopen to re-run CI

bdraco
bdraco approved these changes Mar 11, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @TimMenninger

@bdraco
Copy link
Copy Markdown
Member

bdraco commented Mar 11, 2025

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

@TimMenninger TimMenninger mentioned this pull request Mar 11, 2025
Merged
5 tasks
@TimMenninger TimMenninger force-pushed the update-docs branch 2 times, most recently from 1e3e784 to 67f710f Compare March 11, 2025 17:04
@bdraco bdraco changed the title docs: publish documentation feat(docs): publish documentation Mar 11, 2025
@bdraco bdraco merged commit 4235273 into aio-libs:main Mar 11, 2025
61 of 64 checks passed
@bdraco
Copy link
Copy Markdown
Member

bdraco commented Mar 11, 2025

Thanks @TimMenninger

@webknjaz
Copy link
Copy Markdown
Member

webknjaz commented Mar 11, 2025

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

@bdraco
Copy link
Copy Markdown
Member

bdraco commented Mar 12, 2025

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/
?

@webknjaz
Copy link
Copy Markdown
Member

webknjaz commented Mar 12, 2025

api_reference.rst itself. My understanding is that the new built-in extension regenerates it on every build just like sphinxcontrib.apidoc. This means that the file will generate changes in Git all the time time when it shouldn't.

@webknjaz
Copy link
Copy Markdown
Member

webknjaz commented Mar 12, 2025

Oh, I didn't realize this PR doesn't use the new extension. The names are similar.

But sphinx.ext.apidoc could be integrated to improve this: https://www.sphinx-doc.org/en/master/usage/extensions/apidoc.html#module-sphinx.ext.apidoc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bdraco bdraco bdraco approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@TimMenninger @bdraco @webknjaz