Code

[Docs] Add docs with mkdocs#202

Code

Merged

XinranTang merged 32 commits intogoogle:mastergoogle/ml-metadata:masterfrom smokestacklightnin:ci/docs/add-docssmokestacklightnin/ml-metadata:ci/docs/add-docsCopy head branch name to clipboardOct 24, 2024

+314-55

Commits

Commits on Oct 15, 2024

• Merge pull request google#204 from peytondmurray/17-lint-workflow

  Show description for 49dc26a
  

  XinranTang

  authored and

  smokestacklightnin

  committed
  49dc26a

• Add mkdocs as optional dependency

  smokestacklightnin

  committed
  79eb203

• Add mkdocs.yml along with all necessary files

  smokestacklightnin

  committed
  34d7b80

• Move icon to images folder

  smokestacklightnin

  committed
  0d9e6d6

• Add workflow to deploy docs

  smokestacklightnin

  committed
  15a7747

• Ignore test modules

  smokestacklightnin

  committed
  d6a4e36

• Fix newline issues in "Raises" and "Returns" sections

  smokestacklightnin

  committed
  874787d

• Remove .md

  smokestacklightnin

  committed
  f24501d

• Add empty index.md

  smokestacklightnin

  committed
  476ee22

• Change favicon

  smokestacklightnin

  committed
  e0c3c08

• Add attributes to docstring

  smokestacklightnin

  committed
  2cd9e51

• Temporary fix for unused import

  smokestacklightnin

  committed
  c3131ac

• Fill out Overview section

  smokestacklightnin

  committed
  27905ca

• Use indentation instead of slash character \

  smokestacklightnin

  committed
  941dfe0

• Add overview from mlmd.errors api docs

  smokestacklightnin

  committed
  a510016

• Add show_if_no_docstring option to mlmd.errors

  smokestacklightnin

  committed
  2649a31

• Use spaces instead of tabs

  smokestacklightnin

  committed
  f5b18b8

• Add overview with links.

  Show description for 4802bb2
  smokestacklightnin

  committed
  4802bb2

• Add link to tutorial

  smokestacklightnin

  committed
  47960a4

• Fix repo name

  smokestacklightnin

  committed
  ead6757

• Rename root.md to index.md

  smokestacklightnin

  committed
  18875d8

• Change links to point internally

  smokestacklightnin

  committed
  f5de8a5

• Remove logo

  smokestacklightnin

  committed
  61b75e9

• Fix broken link

  smokestacklightnin

  committed
  946ef60

• Fix admonitions

  smokestacklightnin

  committed
  50ed6c1

• Add white background to png files

  smokestacklightnin

  committed
  3844057

• Add build docs check on pull request

  smokestacklightnin

  committed
  a3adca3

• Remove --verbose flag

  smokestacklightnin

  committed
  7f63761

• Fix triggers

  smokestacklightnin

  committed
  4c2ead1

• Fix link

  smokestacklightnin

  committed
  040369b

• Only trigger on push to master

  smokestacklightnin

  committed
  4525700

Commits on Oct 16, 2024

• Fix linting errors

  smokestacklightnin

  committed
  aea4660