Skip to content

[Code scan] Fix malformed inline math roles in tutorials #26

Description

@njzjz

This issue comes from a Codex global scan of deepmodeling/tbplas at commit 4d3652b.

Severity: Low

Several RST tutorial lines close :math: roles with double backticks. That breaks inline math parsing in Sphinx and can render the surrounding text incorrectly.

Code references:

To calculate :math:`\mathbb{Z}_2`` we need to sample :math:`\mathbf{k}_a` from

insulator. We then decrease the SOC intensity :math:`\lambda`` to 0.15 eV and re-calculate the

replicates the primitive cell along :math:`a`, :math:`b`, and :math:`c`` directions. :func:`apply_pbc`

cells, :math:`i` and :math:`\mathbf{k}`` are band and :math:`\mathbf{k}`-point indices,

:math:`V_{pp\sigma}` and :math:`V_{pp\pi}`` at first and second nearest hopping distances,

:math:`4\times4\times1`` merged cells is created and plotted, with the hopping terms below 0.3 eV

Suggested fix: close each inline math role with a single backtick.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions