Rename g3doc->docs; fix bad links; add bazel-* to .gitignore;

update python; run on push to master
google · Oct 1, 2024 · b96b18b · b96b18b
1 parent 260a824
commit b96b18b
Show file tree

Hide file tree

Showing 16 changed files with 16 additions and 19 deletions.
diff --git a/.github/workflows/cd-docs.yml b/.github/workflows/cd-docs.yml
@@ -2,9 +2,8 @@ name: deploy-docs
 on:
   workflow_dispatch:
   push:
-    # Uncomment these lines before merge
-    # branches:
-    #   - master
+    branches:
+      - master
   pull_request:
 permissions:
   contents: write
@@ -15,16 +14,10 @@ jobs:
       - 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.10
+      - name: Set up Python 3.12
         uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.12'
           cache: 'pip'
           cache-dependency-path: |
             setup.py
@@ -44,8 +37,11 @@ jobs:
         run: pip install -r requirements-docs.txt
 
       - name: Deploy to GitHub Pages
-        run: mkdocs gh-deploy --force
         if: (github.event_name != 'pull_request')
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+          mkdocs gh-deploy --force
 
       - name: Build docs to check for errors
         run: mkdocs build --verbose

diff --git a/.gitignore b/.gitignore
@@ -159,4 +159,7 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+#.idea/
+
+# Bazel build files
+bazel-*
diff --git a/g3doc/api/mlmd.errors/index.md → docs/api/mlmd.errors/index.md b/g3doc/api/mlmd.errors/index.md → docs/api/mlmd.errors/index.md
diff --git a/g3doc/api/mlmd.errors/mlmd.errors.md → docs/api/mlmd.errors/mlmd.errors.md b/g3doc/api/mlmd.errors/mlmd.errors.md → docs/api/mlmd.errors/mlmd.errors.md
diff --git a/g3doc/api/mlmd.proto/index.md → docs/api/mlmd.proto/index.md b/g3doc/api/mlmd.proto/index.md → docs/api/mlmd.proto/index.md
diff --git a/g3doc/api/mlmd.proto/mlmd.proto.md → docs/api/mlmd.proto/mlmd.proto.md b/g3doc/api/mlmd.proto/mlmd.proto.md → docs/api/mlmd.proto/mlmd.proto.md
diff --git a/g3doc/api/mlmd/index.md → docs/api/mlmd/index.md b/g3doc/api/mlmd/index.md → docs/api/mlmd/index.md
diff --git a/g3doc/api/mlmd/mlmd.md → docs/api/mlmd/mlmd.md b/g3doc/api/mlmd/mlmd.md → docs/api/mlmd/mlmd.md
diff --git a/g3doc/images/favicon.png → docs/images/favicon.png b/g3doc/images/favicon.png → docs/images/favicon.png
diff --git a/g3doc/images/mlmd_flow.png → docs/images/mlmd_flow.png b/g3doc/images/mlmd_flow.png → docs/images/mlmd_flow.png
diff --git a/g3doc/images/mlmd_overview.png → docs/images/mlmd_overview.png b/g3doc/images/mlmd_overview.png → docs/images/mlmd_overview.png
diff --git a/g3doc/images/tf_full_color_primary_icon.svg → docs/images/tf_full_color_primary_icon.svg b/g3doc/images/tf_full_color_primary_icon.svg → docs/images/tf_full_color_primary_icon.svg
diff --git a/g3doc/index.md → docs/index.md b/g3doc/index.md → docs/index.md
@@ -556,7 +556,7 @@ ml-metadata (MLMD) | schema_version
 
 The MLMD library has a high-level API that you can readily use with your ML
 pipelines. See the
-[MLMD API documentation](api/mlmd.md)
+[MLMD API documentation](api/mlmd/mlmd.md)
 for more details.
 
 Check out

diff --git a/g3doc/javascripts/mathjax.js → docs/javascripts/mathjax.js b/g3doc/javascripts/mathjax.js → docs/javascripts/mathjax.js
diff --git a/g3doc/stylesheets/extra.css → docs/stylesheets/extra.css b/g3doc/stylesheets/extra.css → docs/stylesheets/extra.css
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,8 +2,6 @@ site_name: "ML Metadata"
 repo_name: "ML Metadata"
 repo_url: https://github.com/google/ml-metadata
 
-docs_dir: g3doc
-
 theme:
   name: material
   palette:
@@ -110,11 +108,11 @@ nav:
   - Tutorial: https://tensorflow.github.io/tfx/tutorials/mlmd/mlmd_tutorial/
   - API:
     - mlmd:
-        - Overview: api/mlmd/
+        - Overview: api/mlmd/index.md
         - mlmd: api/mlmd/mlmd.md
     - mlmd.errors:
-        - Overview: api/mlmd.errors/
+        - Overview: api/mlmd.errors/index.md
         - mlmd.errors: api/mlmd.errors/mlmd.errors.md
     - mlmd.proto:
-        - Overview: api/mlmd.proto/
+        - Overview: api/mlmd.proto/index.md
         - mlmd.proto: api/mlmd.proto/mlmd.proto.md