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.2.tar.gz (29.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: lcdoc-0.0.2.tar.gz
  • Upload date:
  • Size: 29.4 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.2.tar.gz
Algorithm Hash digest
SHA256 b51a881ff35579f2c99491c4cbc994e863b86bec59074510005406a7a9fd530a
MD5 354f416c82e3c8958cc3358bb9f3d7bc
BLAKE2b-256 7e658aedf915337a85c8aadf3709c5722da96027ad12e708aabd9d85557a648c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lcdoc-0.0.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b41b810240143001f943ca96b632f07a38d10e53615713043e6b834d486b1f60
MD5 308182fce29ee1c7320a78f944f70d75
BLAKE2b-256 0a0eb49d45cdc4b27d39592cb9446ed0ac8641307bae73615655e7062cf817a6

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