Add documentation with MkDocs (#268)

* Rename docs directory

* Add documentation dependencies

* Add documentation dependencies to `setup.py`

* Add javascripts

* Add CSS stylesheets

* Add TF logo

* Add readme as landing page

* Add basic mkdocs config

* Use correct index page

* Add images for index page

* Add install and getting started pages to navigation

* Add API docs

* Add docs workflow

* Remove deprecated code

* Check links with lychee in docs workflow

* Revert "Check links with lychee in docs workflow"

This reverts commit 21b3486.

* Add anomalies reference

* Fix bad links in docs

* Fix links that should be internal

* Run pre-commit

Author: smokestacklightnin

.github/workflows/docs.yml

@@ -0,0 +1,52 @@
+name: Deploy docs
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - 'master'
+  pull_request:
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+        if: (github.event_name != 'pull_request')
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+          cache: 'pip'
+          cache-dependency-path: |
+            setup.py
+            requirements-docs.txt
+
+      - name: Save time for cache for mkdocs
+        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+
+      - name: Caching
+        uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - name: Install Dependencies
+        run: pip install -r requirements-docs.txt
+
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force
+        if: (github.event_name != 'pull_request')
+
+      - name: Build docs to check for errors
+        run: mkdocs build
+        if: (github.event_name == 'pull_request')

g3doc/_toc.yaml renamed to docs/_toc.yaml

@@ -0,0 +1,4 @@
+# TensorFlow Data Validation API Documentation
+
+
+::: tensorflow_data_validation

g3doc/anomalies.md renamed to docs/anomalies.md

@@ -6,9 +6,9 @@ freshness: { owner: 'kuochuntsai' reviewed: '2022-11-29' }
 
 TFDV supports custom data validation using SQL. You can run custom data
 validation using
-[validate_statistics](https://github.com/tensorflow/data-validation/blob/master/tensorflow_data_validation/api/validation_api.py;l=236;rcl=488721853)
+[validate_statistics](https://github.com/tensorflow/data-validation/blob/master/tensorflow_data_validation/api/validation_api.py#L236)
 or
-[custom_validate_statistics](https://github.com/tensorflow/data-validation/blob/master/tensorflow_data_validation/api/validation_api.py;l=535;rcl=488721853).
+[custom_validate_statistics](https://github.com/tensorflow/data-validation/blob/master/tensorflow_data_validation/api/validation_api.py#L535).
 Use `validate_statistics` to run standard, schema-based data validation along
 with custom validation. Use `custom_validate_statistics` to run only custom
 validation.