Skip to content

Add documentation with MkDocs #85

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

Open
wants to merge 16 commits into
base: master
Choose a base branch
from

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.

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