Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Docs] Add docs with mkdocs #202

Open
wants to merge 32 commits into
base: master
Choose a base branch
from
Open

[Docs] Add docs with mkdocs #202

wants to merge 32 commits into from

Commits on Oct 15, 2024

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

    Add pre-commit and associated CI
    @XinranTang @smokestacklightnin
    XinranTang authored and smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    49dc26a View commit details
    Browse the repository at this point in the history

  2. Add mkdocs as optional dependency

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    79eb203 View commit details
    Browse the repository at this point in the history

  3. Add mkdocs.yml along with all necessary files

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    34d7b80 View commit details
    Browse the repository at this point in the history

  4. Move icon to images folder

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    0d9e6d6 View commit details
    Browse the repository at this point in the history

  5. Add workflow to deploy docs

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    15a7747 View commit details
    Browse the repository at this point in the history

  6. Ignore test modules

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    d6a4e36 View commit details
    Browse the repository at this point in the history

  7. Fix newline issues in "Raises" and "Returns" sections

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    874787d View commit details
    Browse the repository at this point in the history

  8. Remove .md

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    f24501d View commit details
    Browse the repository at this point in the history

  9. Add empty index.md

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    476ee22 View commit details
    Browse the repository at this point in the history

  10. Change favicon

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    e0c3c08 View commit details
    Browse the repository at this point in the history

  11. Add attributes to docstring

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    2cd9e51 View commit details
    Browse the repository at this point in the history

  12. Temporary fix for unused import

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    c3131ac View commit details
    Browse the repository at this point in the history

  13. Fill out Overview section

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    27905ca View commit details
    Browse the repository at this point in the history

  14. Use indentation instead of slash character \

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    941dfe0 View commit details
    Browse the repository at this point in the history

  15. Add overview from mlmd.errors api docs

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    a510016 View commit details
    Browse the repository at this point in the history

  16. Add show_if_no_docstring option to mlmd.errors

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    2649a31 View commit details
    Browse the repository at this point in the history

  17. Use spaces instead of tabs

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    f5b18b8 View commit details
    Browse the repository at this point in the history

  18. Add overview with links. 

    Links do not work because API for `mlmd.proto` is not showing up yet. Links will work when this is fixed
    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    4802bb2 View commit details
    Browse the repository at this point in the history

  19. Add link to tutorial

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    47960a4 View commit details
    Browse the repository at this point in the history

  20. Fix repo name

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    ead6757 View commit details
    Browse the repository at this point in the history

  21. Rename root.md to index.md

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    18875d8 View commit details
    Browse the repository at this point in the history

  22. Change links to point internally

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    f5de8a5 View commit details
    Browse the repository at this point in the history

  23. Remove logo

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    61b75e9 View commit details
    Browse the repository at this point in the history

  24. Fix broken link

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    946ef60 View commit details
    Browse the repository at this point in the history

  25. Fix admonitions

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    50ed6c1 View commit details
    Browse the repository at this point in the history

  26. Add white background to png files

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    3844057 View commit details
    Browse the repository at this point in the history

  27. Add build docs check on pull request

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    a3adca3 View commit details
    Browse the repository at this point in the history

  28. Remove --verbose flag

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    7f63761 View commit details
    Browse the repository at this point in the history

  29. Fix triggers

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    4c2ead1 View commit details
    Browse the repository at this point in the history

  30. Fix link

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    040369b View commit details
    Browse the repository at this point in the history

  31. Only trigger on push to master

    @smokestacklightnin
    smokestacklightnin committed Oct 15, 2024
    Configuration menu
    Copy the full SHA
    4525700 View commit details
    Browse the repository at this point in the history

Commits on Oct 16, 2024

  1. Fix linting errors

    @smokestacklightnin
    smokestacklightnin committed Oct 16, 2024
    Configuration menu
    Copy the full SHA
    aea4660 View commit details
    Browse the repository at this point in the history