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

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

Uploaded Source

File details

Details for the file sphinx-docslab-0.1.1.tar.gz.

File metadata

  • Download URL: sphinx-docslab-0.1.1.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.4

File hashes

Hashes for sphinx-docslab-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7c7a200f388f9682c4e7190ad02b32fc80028145968fcebb8a97a7c1c7dbbe74
MD5 fda5e5deca022e859619b9f2acc12e81
BLAKE2b-256 ef00078a04d0909ae0bdb988d25c64d088e11ac72988ea2611adb175c2b335ab

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.1 This release

1 file

0.1.0

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page