Skip to main content

Sphinx docslab extension for interactive code

Project description

This Sphinx extension uses docslab to make code blocks interactive.

First, install it from PyPI:

pip install sphinx-docslab

Then, add it to your conf.py file.

extensions = ['sphinx_docslab']

To create an interactive code block, use the docslab directive. For example,

.. docslab:: heliumdev/cubecell-draw-demo
    :lang: cpp
    :readonly:
    :command: source .platformio/penv/bin/activate && cd m/Heltec-CubeCell-Board/examples/cubecell-helium-us915-basic && pio run -t upload && pio device monitor
    :repo: https://github.com/helium/longfi-platformio.git
    :path: m/Heltec-CubeCell-Board/examples/cubecell-helium-us915-basic/src/main.cpp

    #include <Arduino.h>
    #include <stdio.h>

    void setup()
    {
        Serial.begin(115200);
    }

    void loop()
    {
        delay(1000);
        Serial.println("Hola, mundo!");
    }

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

sphinx-docslab-0.1.1.tar.gz (3.5 kB view hashes)

Uploaded Source

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