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] Use mkdocs for documentation #2254

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

[Docs] Use mkdocs for documentation #2254

wants to merge 38 commits into from

Commits on Sep 24, 2024

  1. Get basic documentation up and running

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    d313040 View commit details
    Browse the repository at this point in the history

  2. Add basic documentation deployment workflow

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    40e2829 View commit details
    Browse the repository at this point in the history

  3. Add cache dependency path

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    bb78fe4 View commit details
    Browse the repository at this point in the history

  4. Add empty index page

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    5a8148d View commit details
    Browse the repository at this point in the history

  5. Fix internal links

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    7012295 View commit details
    Browse the repository at this point in the history

  6. Fix broken links

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    407e1b5 View commit details
    Browse the repository at this point in the history

  7. Fix bash command listing

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    9efc0c2 View commit details
    Browse the repository at this point in the history

  8. Fix virbatim text

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    9689343 View commit details
    Browse the repository at this point in the history

  9. Fix broken link

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    8330c42 View commit details
    Browse the repository at this point in the history

  10. Fix broken link

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    b857e67 View commit details
    Browse the repository at this point in the history

  11. Fix broken links

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    bf4b58f View commit details
    Browse the repository at this point in the history

  12. Add REST api docs

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    c78f143 View commit details
    Browse the repository at this point in the history

  13. Add gRPC api docs

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    d9ee576 View commit details
    Browse the repository at this point in the history

  14. Reorganize guide and tutorial files and fix links

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    c794ab1 View commit details
    Browse the repository at this point in the history

  15. Add tutorials to docs

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    3af20e0 View commit details
    Browse the repository at this point in the history

  16. Fix admonitions

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    d3399f5 View commit details
    Browse the repository at this point in the history

  17. Fix broken links

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    660d28d View commit details
    Browse the repository at this point in the history

  18. Move landing page to index.md

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    163c8f4 View commit details
    Browse the repository at this point in the history

  19. Add white background to images

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    01951b3 View commit details
    Browse the repository at this point in the history

  20. Add placeholder for C++ docs

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    00e32b8 View commit details
    Browse the repository at this point in the history

  21. Remove logo

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    81c9dce View commit details
    Browse the repository at this point in the history

  22. Change workflow triggers from debugging to production settings

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    65e463e View commit details
    Browse the repository at this point in the history

  23. Add link to C++ api docs placeholder

    @smokestacklightnin
    smokestacklightnin committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    0b70681 View commit details
    Browse the repository at this point in the history

Commits on Sep 30, 2024

  1. Add build docs check on pull request

    @smokestacklightnin
    smokestacklightnin committed Sep 30, 2024
    Configuration menu
    Copy the full SHA
    f2dbc9d View commit details
    Browse the repository at this point in the history

Commits on Oct 2, 2024

  1. Move docs to standard location; fix links

    @peytondmurray
    peytondmurray committed Oct 2, 2024
    Configuration menu
    Copy the full SHA
    36e085f View commit details
    Browse the repository at this point in the history

Commits on Oct 14, 2024

  1. Bump Python version

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

  2. Move docs requirements to common location

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

  3. Only trigger on push to master

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

Commits on Oct 15, 2024

  1. Build docs with Doxygen

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

  2. Install Doxygen in deploy GH action

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

  3. Install graphviz to generate Doxygen diagrams

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

  4. Install doxygen with apt

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

  5. Fix link on homepage

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

  6. Remove commented import

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

  7. Simplify url

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

Commits on Oct 16, 2024

  1. Add a splash page for the cpp docs; clean up hook; add gitignore

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

  2. Remove unused icon

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

  3. Point to landing page

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