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: Document refactored tracing #936

Draft
wants to merge 8 commits into
base: maxgamill-sheffield/800-better-tracing
Choose a base branch
from
Draft

docs: Document refactored tracing #936

wants to merge 8 commits into from

Commits on Oct 8, 2024

  1. docs: Document refactored tracing 

    - Disordered tracing
- Nodestats
- Ordered tracing
- Splining
    @MaxGamill-Sheffield @ns-rse
    MaxGamill-Sheffield authored and ns-rse committed Oct 8, 2024
    Configuration menu
    Copy the full SHA
    d503f47 View commit details
    Browse the repository at this point in the history

  2. docs(advanced): lint advanced/*.md 

    As per Markdown linting defined in `.markdownlint-cli2.yaml`

- Wrap lines at 120 characters.
- Fix all other linting errors automatically.
    @ns-rse
    ns-rse committed Oct 8, 2024
    Configuration menu
    Copy the full SHA
    f43c4e3 View commit details
    Browse the repository at this point in the history

  3. docs(conf): Add myst_heading_anchors option 

    As per [myst docs](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#auto-generated-header-anchors)
setting the `myst_heading_anchors` sets the maximum depth for auto-generating label "slugs" for section headers.

Helps resolve some, but not all, complaints about internal links.
    @ns-rse
    ns-rse committed Oct 8, 2024
    Configuration menu
    Copy the full SHA
    a765a90 View commit details
    Browse the repository at this point in the history

  4. docs: Remove Markdown footnotes 

    Myst-Parser complains about the use of Markdown footnotes (e.g. `[^1]`) therefore switch these to alternatives.
    @ns-rse
    ns-rse committed Oct 8, 2024
    Configuration menu
    Copy the full SHA
    4ffbe78 View commit details
    Browse the repository at this point in the history

  5. docs: Fixing various links

    @ns-rse
    ns-rse committed Oct 8, 2024
    Configuration menu
    Copy the full SHA
    278ad9e View commit details
    Browse the repository at this point in the history

  6. ci: Update Sphinx to GH pages config with renamed options

    @ns-rse
    ns-rse committed Oct 8, 2024
    Configuration menu
    Copy the full SHA
    7db1600 View commit details
    Browse the repository at this point in the history

  7. wip: troubleshooting Advanced Documentation toctree

    @ns-rse
    ns-rse committed Oct 8, 2024
    Configuration menu
    Copy the full SHA
    2824129 View commit details
    Browse the repository at this point in the history

Commits on Oct 9, 2024

  1. Merge branch 'maxgamill-sheffield/800-better-tracing' into maxgamill-… 

    …sheffield/btr-docs
    @MaxGamill-Sheffield
    MaxGamill-Sheffield authored Oct 9, 2024
    Configuration menu
    Copy the full SHA
    4ac1742 View commit details
    Browse the repository at this point in the history