Skip to main content

LC documentation generator

Project description

lcdoc

LC documentation generator

Markup Features

  • sub-documentation for each member
  • authomatic code blocks and inline code blocks highlighting using highlightjs
    ```cpp
    int i = 42
    ```
    
  • manual syntax highlighting support using user friendly <code-*> tags
    <pre><code>
        <code-keyword>int</code-keyword> <code-var>i</code-var> = <code-number>42</code-number>;
    </code></pre>
    
  • LaTex equations rendering using tex-math package (based on katex) :
    inline equation: <i-math>x^2</i-math>
    equation:
    <tex-math>
        i \hbar \frac{\partial}{\partial t} \psi = H \psi
    </tex-math>
    

dependencies:

We use libclang Python binding, doc here, see also

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lcdoc-0.0.3.tar.gz (29.3 kB view details)

Uploaded Source

Built Distribution

lcdoc-0.0.3-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

Details for the file lcdoc-0.0.3.tar.gz.

File metadata

  • Download URL: lcdoc-0.0.3.tar.gz
  • Upload date:
  • Size: 29.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for lcdoc-0.0.3.tar.gz
Algorithm Hash digest
SHA256 0a393b47a327fffd8c65e7b627812c76e2be5e080ac70a3c7121a1d146ec84e3
MD5 17405c648e0a59fd46348daa52367311
BLAKE2b-256 499a0e2150c3500d68b6f41f569360e1d2895bde9ed9c40bcbed6744cbca8e9d

See more details on using hashes here.

File details

Details for the file lcdoc-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: lcdoc-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 32.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for lcdoc-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 692e45ad729d274067dae9d3b9c1d647030f5c71771bcad252948e8c18b3350d
MD5 b6ca43d5bee5ba6dad3807508f050510
BLAKE2b-256 3b8f78164be09e5e310d5833945a40579828e5cd80cad524d7c13c4219734d1e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page