Skip to main content

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!");
    }

Metadata

Release files for sphinx-docslab 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-docslab 0.1.1
File Size Uploaded
sphinx-docslab-0.1.1.tar.gz 3.5 kB Details

Release files / sphinx-docslab-0.1.1.tar.gz

Download URL sphinx-docslab-0.1.1.tar.gz
Size 3.5 kB
Tags Source
SHA-256 checksum
How to use checksums
7c7a200f388f9682c4e7190ad02b32fc80028145968fcebb8a97a7c1c7dbbe74
BLAKE2b-256 checksum
How to use checksums
ef00078a04d0909ae0bdb988d25c64d088e11ac72988ea2611adb175c2b335ab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.4

Release history Release notifications | RSS feed

This release

0.1.1 This release

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page