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

Update the docs #236

Draft
wants to merge 37 commits into
base: main
Choose a base branch
from
Draft

Update the docs #236

wants to merge 37 commits into from

Commits on Aug 27, 2024

  1. Update docstrings

    @robomics
    robomics committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    76d25f4 View commit details
    Browse the repository at this point in the history

  2. Update the README

    @robomics
    robomics committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    4b7efe8 View commit details
    Browse the repository at this point in the history

  3. Update CLI reference

    @robomics
    robomics committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    a4ec9f1 View commit details
    Browse the repository at this point in the history

  4. Update requirements.txt for the docs

    @robomics
    robomics committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    d7772db View commit details
    Browse the repository at this point in the history

  5. Update test dataset download instructions

    @robomics
    robomics committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    48adae4 View commit details
    Browse the repository at this point in the history

  6. Fix typo

    @robomics
    robomics committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    cde25b0 View commit details
    Browse the repository at this point in the history

  7. Add docs for hictk metadata

    @robomics
    robomics committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    4815d0a View commit details
    Browse the repository at this point in the history

Commits on Sep 19, 2024

  1. Update CLI reference [no ci]

    @robomics
    robomics committed Sep 19, 2024
    Configuration menu
    Copy the full SHA
    1adccb6 View commit details
    Browse the repository at this point in the history

Commits on Sep 24, 2024

  1. Add missing SPDX header [no ci]

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

Commits on Sep 26, 2024

  1. Merge branch 'main' into docs/update

    @robomics
    robomics committed Sep 26, 2024
    Configuration menu
    Copy the full SHA
    a64422a View commit details
    Browse the repository at this point in the history

  2. Update docs for C++ API

    @robomics
    robomics committed Sep 26, 2024
    Configuration menu
    Copy the full SHA
    cedf5a9 View commit details
    Browse the repository at this point in the history

Commits on Sep 27, 2024

  1. Update docs and tutorials for hictk 

    [no ci]
    @robomics
    robomics committed Sep 27, 2024
    Configuration menu
    Copy the full SHA
    fde7770 View commit details
    Browse the repository at this point in the history

  2. hictk load: document supported compression algorithms 

    [no ci]
    @robomics
    robomics committed Sep 27, 2024
    Configuration menu
    Copy the full SHA
    9ef8937 View commit details
    Browse the repository at this point in the history

Commits on Sep 28, 2024

  1. Update docs for To*Matrix transformers 

    [no ci]
    @robomics
    robomics committed Sep 28, 2024
    Configuration menu
    Copy the full SHA
    dc66df5 View commit details
    Browse the repository at this point in the history

Commits on Sep 30, 2024

  1. Merge branch 'main' into docs/update

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

  2. Update CITATION.cff and add workflow to lint CITATION.cff

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

  3. Add pre-commit hook to lint the docs

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

  4. Update CLI reference

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

  5. Revert "Add pre-commit hook to lint the docs" 

    This reverts commit dd27ca7.
    @robomics
    robomics committed Sep 30, 2024
    Configuration menu
    Copy the full SHA
    c840e23 View commit details
    Browse the repository at this point in the history

  6. Merge branch 'main' into docs/update

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

  7. [no ci]

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

  8. [no ci]

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

  9. Fix PDF docs

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

  10. Rewrite generate_cli_reference script in python

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

  11. Fix incorrect display of std::uint8_t default values in the CLI help … 

    …message
    @robomics
    robomics committed Sep 30, 2024
    Configuration menu
    Copy the full SHA
    1f432a2 View commit details
    Browse the repository at this point in the history

  12. Remove unnecessary extension from docs/conf.py

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

  13. Switch to using build.commands in .readthedocs.yaml in preparation fo… 

    …r RTD Addons

https://about.readthedocs.com/blog/2024/07/addons-by-default/
    @robomics
    robomics committed Sep 30, 2024
    Configuration menu
    Copy the full SHA
    0ac5fbd View commit details
    Browse the repository at this point in the history

  14. [no ci]

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

  15. Bugfix [no ci]

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

  16. Check for broken links when building the docs

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

  17. Fix broken link [no ci]

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

  18. Fix PDF docs [no ci]

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

  19. Update doc URLS

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

  20. Add script to automate updating doc links in index.rst 

    [no ci]
    @robomics
    robomics committed Sep 30, 2024
    Configuration menu
    Copy the full SHA
    5ff23bc View commit details
    Browse the repository at this point in the history

  21. Bugfix [no ci]

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

  22. Improve formatting [no ci]

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

  23. Run linkcheck after patching index.rst [no ci]

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