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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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