Skip to content

Conversation

@smokestacklightnin
Copy link
Member

@smokestacklightnin smokestacklightnin commented May 12, 2025

This PR adds guide and API documentation using MkDocs.

Depending on how much time the decision makers want me to spend, I can fix MarkDown formatting issues. Until then, the docs contained herein are still usable.

Only modules written in Python are included. Modules coming from protocol buffers are not included.

A preview can be found here.

@smokestacklightnin smokestacklightnin marked this pull request as draft May 12, 2025 02:56
@peytondmurray peytondmurray marked this pull request as ready for review May 12, 2025 18:04
@peytondmurray
Copy link
Contributor

As a matter of preference I'd vote to preserve the nesting of tfx_bs.public.tfxio, i.e. make separate pages for each submodule. As it stands, mkdocstrings flattens the module hierarchy, and that page ends up being suuuuuper long: https://smokestacklightnin.github.io/tfx-bsl/api_docs/python/tfxio/. To address that I think it would be nice to make just a separate page for each module - would that be okay?

@smokestacklightnin
Copy link
Member Author

As a matter of preference I'd vote to preserve the nesting of tfx_bs.public.tfxio, i.e. make separate pages for each submodule. As it stands, mkdocstrings flattens the module hierarchy, and that page ends up being suuuuuper long: https://smokestacklightnin.github.io/tfx-bsl/api_docs/python/tfxio/. To address that I think it would be nice to make just a separate page for each module - would that be okay?

I had actually included the wrong modules, but it is fixed now. Now only the correct classes for the correct module are included, and the page is not nearly as long.

@peytondmurray peytondmurray merged commit 959724b into tensorflow:master Jun 20, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants