Add documentation with MkDocs #512
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
smokestacklightnin
force-pushed
the
ci/docs/add-mkdocs
branch
from
232ea89 to
5099efa
Compare
|
There are two
|
I have fixed the links. The "Using Fairness Indicators with Pandas DataFrames" link will not work until the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.