Skip to content

Add documentation with MkDocs #512

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 29 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.

When this PR is merged, the TFX docs should be updated to point to the appropriate pages for this repo.

@peytondmurray
Copy link
Contributor

peytondmurray commented May 12, 2025

There are two None entries in the sidebar which are broken - are these missing documents, or something that can be removed?

image

@peytondmurray peytondmurray marked this pull request as ready for review May 12, 2025 17:57
@smokestacklightnin
Copy link
Member Author

There are two None entries in the sidebar which are broken - are these missing documents, or something that can be removed?

image

I have fixed the links. The "Using Fairness Indicators with Pandas DataFrames" link will not work until the fairness-indicators documenation PR is merged.

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