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

Switch from sphinx to use mkdocs #209

Merged
merged 15 commits into from
Nov 15, 2023
Merged

Switch from sphinx to use mkdocs #209

merged 15 commits into from
Nov 15, 2023

Commits on Nov 14, 2023

  1. Remove sphinx workflow, restructure .rst files

    @ens-LCampbell
    ens-LCampbell committed Nov 14, 2023
    Configuration menu
    Copy the full SHA
    16766fc View commit details
    Browse the repository at this point in the history

  2. Initalise mkdocs setup and MDs

    @ens-LCampbell
    ens-LCampbell committed Nov 14, 2023
    Configuration menu
    Copy the full SHA
    5e26407 View commit details
    Browse the repository at this point in the history

  3. Update project TOML, alter build sphinx script

    @ens-LCampbell
    ens-LCampbell committed Nov 14, 2023
    Configuration menu
    Copy the full SHA
    8e832d7 View commit details
    Browse the repository at this point in the history

  4. Update docs/usage.md 

    add code snippet to improve readability

Co-authored-by: J. Alvarez-Jarreta <[email protected]>
    @ens-LCampbell @JAlvarezJarreta
    ens-LCampbell and JAlvarezJarreta authored Nov 14, 2023
    Configuration menu
    Copy the full SHA
    203c458 View commit details
    Browse the repository at this point in the history

  5. Update docs/install.md 

    Update install instructions

Co-authored-by: J. Alvarez-Jarreta <[email protected]>
    @ens-LCampbell @JAlvarezJarreta
    ens-LCampbell and JAlvarezJarreta authored Nov 14, 2023
    Configuration menu
    Copy the full SHA
    cb729d9 View commit details
    Browse the repository at this point in the history

  6. Update docs/install.md 

    Update to PERL deps

Co-authored-by: J. Alvarez-Jarreta <[email protected]>
    @ens-LCampbell @JAlvarezJarreta
    ens-LCampbell and JAlvarezJarreta authored Nov 14, 2023
    Configuration menu
    Copy the full SHA
    065caf8 View commit details
    Browse the repository at this point in the history

  7. Update docs/gen_ref_pages.py 

    remove debug lines

Co-authored-by: J. Alvarez-Jarreta <[email protected]>
    @ens-LCampbell @JAlvarezJarreta
    ens-LCampbell and JAlvarezJarreta authored Nov 14, 2023
    Configuration menu
    Copy the full SHA
    1a33365 View commit details
    Browse the repository at this point in the history

  8. Update docs/gen_ref_pages.py 

    remove unused comments

Co-authored-by: J. Alvarez-Jarreta <[email protected]>
    @ens-LCampbell @JAlvarezJarreta
    ens-LCampbell and JAlvarezJarreta authored Nov 14, 2023
    Configuration menu
    Copy the full SHA
    4c6546c View commit details
    Browse the repository at this point in the history

  9. Update docs/gen_ref_pages.py 

    remove unused comments

Co-authored-by: J. Alvarez-Jarreta <[email protected]>
    @ens-LCampbell @JAlvarezJarreta
    ens-LCampbell and JAlvarezJarreta authored Nov 14, 2023
    Configuration menu
    Copy the full SHA
    f9abdb9 View commit details
    Browse the repository at this point in the history

  10. Update docs/gen_ref_pages.py 

    remove unused comments

Co-authored-by: J. Alvarez-Jarreta <[email protected]>
    @ens-LCampbell @JAlvarezJarreta
    ens-LCampbell and JAlvarezJarreta authored Nov 14, 2023
    Configuration menu
    Copy the full SHA
    14ecda6 View commit details
    Browse the repository at this point in the history

  11. Update docs/install.md 

    Update required python modules

Co-authored-by: J. Alvarez-Jarreta <[email protected]>
    @ens-LCampbell @JAlvarezJarreta
    ens-LCampbell and JAlvarezJarreta authored Nov 14, 2023
    Configuration menu
    Copy the full SHA
    3215416 View commit details
    Browse the repository at this point in the history

  12. Updated to Site name, YAML, licensing

    @ens-LCampbell
    ens-LCampbell committed Nov 14, 2023
    Configuration menu
    Copy the full SHA
    de54533 View commit details
    Browse the repository at this point in the history

  13. remove sphinx legacy setup, source, .rst files

    @ens-LCampbell
    ens-LCampbell committed Nov 14, 2023
    Configuration menu
    Copy the full SHA
    0592190 View commit details
    Browse the repository at this point in the history

Commits on Nov 15, 2023

  1. Update docs/index.md 

    Thank you

Co-authored-by: J. Alvarez-Jarreta <[email protected]>
    @ens-LCampbell @JAlvarezJarreta
    ens-LCampbell and JAlvarezJarreta authored Nov 15, 2023
    Configuration menu
    Copy the full SHA
    0edbea8 View commit details
    Browse the repository at this point in the history

  2. Update docs/usage.md 

    Co-authored-by: J. Alvarez-Jarreta <[email protected]>
    @ens-LCampbell @JAlvarezJarreta
    ens-LCampbell and JAlvarezJarreta authored Nov 15, 2023
    Configuration menu
    Copy the full SHA
    1d1a32d View commit details
    Browse the repository at this point in the history