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

Add User Guides to the docs #43

Merged
merged 36 commits into from
Jul 16, 2024
Merged

Add User Guides to the docs #43

merged 36 commits into from
Jul 16, 2024

Commits on Jul 10, 2024

  1. fix external links

    @elliotfontaine
    elliotfontaine committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    65397c4 View commit details
    Browse the repository at this point in the history

  2. use intersphinx for cylc glossary

    @elliotfontaine
    elliotfontaine committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    74bbfc8 View commit details
    Browse the repository at this point in the history

  3. load intersphinx extension

    @elliotfontaine
    elliotfontaine committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    fff2dae View commit details
    Browse the repository at this point in the history

  4. fix rose docs version

    @elliotfontaine
    elliotfontaine committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    ef3be25 View commit details
    Browse the repository at this point in the history

  5. fix rose uri in intersphinx

    @elliotfontaine
    elliotfontaine committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    efe9476 View commit details
    Browse the repository at this point in the history

  6. make config autodoc keep items order

    @elliotfontaine
    elliotfontaine committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    8d41e93 View commit details
    Browse the repository at this point in the history

  7. update config docstrings

    @elliotfontaine
    elliotfontaine committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    d33d092 View commit details
    Browse the repository at this point in the history

  8. small fixes to docs

    @elliotfontaine
    elliotfontaine committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    246ed66 View commit details
    Browse the repository at this point in the history

  9. start of InfluxDB guide

    @elliotfontaine
    elliotfontaine committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    5f83e73 View commit details
    Browse the repository at this point in the history

Commits on Jul 11, 2024

  1. use external link roles for RTMet repo

    @elliotfontaine
    elliotfontaine committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    3ccf963 View commit details
    Browse the repository at this point in the history

  2. add sphinx_design extension for cool icons

    @elliotfontaine
    elliotfontaine committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    11837c6 View commit details
    Browse the repository at this point in the history

  3. fix cylc doc version for intersphinx links

    @elliotfontaine
    elliotfontaine committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    166baf7 View commit details
    Browse the repository at this point in the history

  4. test direct linking using :download:

    @elliotfontaine
    elliotfontaine committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    d3e77c9 View commit details
    Browse the repository at this point in the history

  5. write Setting up the bioreactor dashboard

    @elliotfontaine
    elliotfontaine committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    2bcc751 View commit details
    Browse the repository at this point in the history

  6. explain how to manipulate the dashboard

    @elliotfontaine
    elliotfontaine committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    913bc87 View commit details
    Browse the repository at this point in the history

  7. improve config docstrings

    @elliotfontaine
    elliotfontaine committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    417688b View commit details
    Browse the repository at this point in the history

  8. move tutorial reference tag before page title

    @elliotfontaine
    elliotfontaine committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    bb7b58b View commit details
    Browse the repository at this point in the history

  9. typo and small fixes

    @elliotfontaine
    elliotfontaine committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    91a187a View commit details
    Browse the repository at this point in the history

  10. test intersphinx :ref:

    @elliotfontaine
    elliotfontaine committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    e3e22e9 View commit details
    Browse the repository at this point in the history

  11. better :ref: nomenclature

    @elliotfontaine
    elliotfontaine committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    b603100 View commit details
    Browse the repository at this point in the history

  12. fix ref inside config docstring

    @elliotfontaine
    elliotfontaine committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    f583333 View commit details
    Browse the repository at this point in the history

  13. fix it again...

    @elliotfontaine
    elliotfontaine committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    ae356f8 View commit details
    Browse the repository at this point in the history

Commits on Jul 12, 2024

  1. write "workflow control" guide

    @elliotfontaine
    elliotfontaine committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    aca1a94 View commit details
    Browse the repository at this point in the history

  2. use correct compounds_db.csv source to build the 5-row table

    @elliotfontaine
    elliotfontaine committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    0e585f9 View commit details
    Browse the repository at this point in the history

  3. fix intersphinx references

    @elliotfontaine
    elliotfontaine committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    2b7409e View commit details
    Browse the repository at this point in the history

  4. remove 'Installing JupytherHub' section, since there is no installati… 

    …on for that
    @elliotfontaine
    elliotfontaine committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    8b1c1a6 View commit details
    Browse the repository at this point in the history

  5. how to transfer files guide

    @elliotfontaine
    elliotfontaine committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    76078c9 View commit details
    Browse the repository at this point in the history

Commits on Jul 15, 2024

  1. finish writing up how to automate file transfers

    @elliotfontaine
    elliotfontaine committed Jul 15, 2024
    Configuration menu
    Copy the full SHA
    db8e76b View commit details
    Browse the repository at this point in the history

  2. fix indentation in bullet point list

    @elliotfontaine
    elliotfontaine committed Jul 15, 2024
    Configuration menu
    Copy the full SHA
    a2a934d View commit details
    Browse the repository at this point in the history

  3. make bullet points not span multiple lines

    @elliotfontaine
    elliotfontaine committed Jul 15, 2024
    Configuration menu
    Copy the full SHA
    6cefe60 View commit details
    Browse the repository at this point in the history

  4. replace list symbol (- to *)

    @elliotfontaine
    elliotfontaine committed Jul 15, 2024
    Configuration menu
    Copy the full SHA
    e0b915a View commit details
    Browse the repository at this point in the history

  5. remove WIP warning

    @elliotfontaine
    elliotfontaine committed Jul 15, 2024
    Configuration menu
    Copy the full SHA
    8c3fa41 View commit details
    Browse the repository at this point in the history

  6. formatting

    @elliotfontaine
    elliotfontaine committed Jul 15, 2024
    Configuration menu
    Copy the full SHA
    53643ef View commit details
    Browse the repository at this point in the history

Commits on Jul 16, 2024

  1. add references for on-line metabolomics

    @elliotfontaine
    elliotfontaine committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    7bf3e43 View commit details
    Browse the repository at this point in the history

  2. reference the two Cortada_Garcia et al. papers

    @elliotfontaine
    elliotfontaine committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    cc3e3a1 View commit details
    Browse the repository at this point in the history

  3. quoting titles

    @elliotfontaine
    elliotfontaine committed Jul 16, 2024
    Configuration menu
    Copy the full SHA
    d3236c5 View commit details
    Browse the repository at this point in the history