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

Migrate Doc to ReadTheDocs #101

Merged
merged 43 commits into from
Feb 16, 2024
Merged

Migrate Doc to ReadTheDocs #101

merged 43 commits into from
Feb 16, 2024

Commits on Feb 14, 2024

  1. Merge branch 'ReloadAPI'

    @cindytsai
    cindytsai committed Feb 14, 2024
    Configuration menu
    Copy the full SHA
    2a191dd View commit details
    Browse the repository at this point in the history

  2. Should wrap in INTERACTIVE_MODE

    @cindytsai
    cindytsai committed Feb 14, 2024
    Configuration menu
    Copy the full SHA
    a304035 View commit details
    Browse the repository at this point in the history

  3. Fix the doc.

    @cindytsai
    cindytsai committed Feb 14, 2024
    Configuration menu
    Copy the full SHA
    6e28880 View commit details
    Browse the repository at this point in the history

  4. grammer

    @cindytsai
    cindytsai committed Feb 14, 2024
    Configuration menu
    Copy the full SHA
    b8902c3 View commit details
    Browse the repository at this point in the history

  5. Update doc.

    @cindytsai
    cindytsai committed Feb 14, 2024
    Configuration menu
    Copy the full SHA
    48a6f3c View commit details
    Browse the repository at this point in the history

  6. Merge branch 'Fix'

    @cindytsai
    cindytsai committed Feb 14, 2024
    Configuration menu
    Copy the full SHA
    9f7d5fc View commit details
    Browse the repository at this point in the history

Commits on Feb 15, 2024

  1. Initialize sphinx using furo theme. 

    1. set up conf.py
2. move figures to _static/
This would definitely failed to compile and render, so the following commit will be fixing it until it works.
    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    c4ffe9e View commit details
    Browse the repository at this point in the history

  2. Link all the doc files.

    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    860f0f9 View commit details
    Browse the repository at this point in the history

  3. Add badge

    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    7db1ed8 View commit details
    Browse the repository at this point in the history

  4. Exclude README.md and Set H1 header. 

    README.md for showing on github about how to start and compile sphinx.
H1 header will show in left sidebar.
    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    c6ac555 View commit details
    Browse the repository at this point in the history

  5. Make some headers don't show in right sidebar. 

    change {.no_toc} to ::: wrapping the header.
    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    c58f884 View commit details
    Browse the repository at this point in the history

  6. rename file.

    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    1e83ae4 View commit details
    Browse the repository at this point in the history

  7. Fix libyt API table.

    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    2e8f1f5 View commit details
    Browse the repository at this point in the history

  8. Change the emoji

    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    faac3f0 View commit details
    Browse the repository at this point in the history

  9. Change some long headings to a shorter one.

    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    0428860 View commit details
    Browse the repository at this point in the history

  10. Update emoji to octicon

    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    4786cac View commit details
    Browse the repository at this point in the history

  11. change heading.

    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    e299d9c View commit details
    Browse the repository at this point in the history

  12. Make heading with code wrap in ``.

    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    c18e006 View commit details
    Browse the repository at this point in the history

  13. Fix grammer, and move status board from interactive mode to libyt com… 

    …mands.
    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    647ceb9 View commit details
    Browse the repository at this point in the history

  14. Fix linking to header

    @cindytsai
    cindytsai committed Feb 15, 2024
    Configuration menu
    Copy the full SHA
    8ea2649 View commit details
    Browse the repository at this point in the history

Commits on Feb 16, 2024

  1. Fix the link in first layer.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    f05992f View commit details
    Browse the repository at this point in the history

  2. fix link.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    c342cf6 View commit details
    Browse the repository at this point in the history

  3. fix link in user provide parameter api and field info api.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    5ed1df7 View commit details
    Browse the repository at this point in the history

  4. fix links in libyt-api folder layer.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    7f27374 View commit details
    Browse the repository at this point in the history

  5. Fix all the links in libyt-api folder layer.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    38b5e94 View commit details
    Browse the repository at this point in the history

  6. fix link in in-situ-python-analysis

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    591741a View commit details
    Browse the repository at this point in the history

  7. fix the link in in-situ-python-analysis folder layer.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    1130b57 View commit details
    Browse the repository at this point in the history

  8. fix the link in interactive prompt

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    af2c8b7 View commit details
    Browse the repository at this point in the history

  9. Fix link in jupyter notebook.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    8f34494 View commit details
    Browse the repository at this point in the history

  10. Fix the link.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    03ac78a View commit details
    Browse the repository at this point in the history

  11. Fix link and text block.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    bf1146e View commit details
    Browse the repository at this point in the history

  12. Fix link.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    d375e25 View commit details
    Browse the repository at this point in the history

  13. trying to fix the heading anchor slug used in furo. 

    anchor slug used in furo after built and the one used in myst markdown are not the same!
And I just found out now, damn have been copy and past the link everywhere.
    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    95c7c35 View commit details
    Browse the repository at this point in the history

  14. Change image name to indicate light/dark mode.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    67f218c View commit details
    Browse the repository at this point in the history

  15. Make images shown only in light mode.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    58e72c9 View commit details
    Browse the repository at this point in the history

  16. Add reloading script workflow image dark mode.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    3adcd63 View commit details
    Browse the repository at this point in the history

  17. Add overview image dark mode.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    7673627 View commit details
    Browse the repository at this point in the history

  18. Add pass in data image dark mode.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    053069d View commit details
    Browse the repository at this point in the history

  19. Add python ask data image dark mode.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    2905d62 View commit details
    Browse the repository at this point in the history

  20. Add RMA image dark mode.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    a4c9a73 View commit details
    Browse the repository at this point in the history

  21. Remove github pages deployment.

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    f7f451a View commit details
    Browse the repository at this point in the history

  22. Merge remote-tracking branch 'yt-project/main' into merge-yt

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    2af747b View commit details
    Browse the repository at this point in the history

  23. Merge branch 'ReadTheDoc' into merge-yt (yt-project/libyt main branch)

    @cindytsai
    cindytsai committed Feb 16, 2024
    Configuration menu
    Copy the full SHA
    28dd1a6 View commit details
    Browse the repository at this point in the history