Skip to main content

A lightweight example directive to make it easy to demonstrate code / results.

Project description

sphinx-examples

A small Sphinx extension to create examples of source markup and the result of rendering it in your documentation. This is useful if you wish to demonstrate the functionality of a new directive or role in Sphinx.

🚨This is very alpha software🚨: It is packaged primarily for convience and not heavily tested. Use at your own risk!

Installation

You can install sphinx-examples with pip:

pip install sphinx-examples

Usage

See the sphinx-examples documentation for more information.

Develop

To develop this extension, follow these steps:

  1. Clone the repository locally

    $ git clone https://github.com/executablebooks/sphinx-examples
    $ cd sphinx-examples
    
  2. Install pre-commit hooks

    $ pre-commit install
    
  3. Install development and documentation dependencies

    $ pip install -e .[sphinx]
    

The codebase for this package is in src/sphinx_examples. Documentation is in docs/.

This package has no testing infrastructure, so be careful when using it! If it becomes more complex or with more features, we may add more testing around it in the future. For not it is packaged for convenience and re-use across EBP repositories.

Build the documentation

The documentation is currently not hosted anywhere, so if you'd like to preview the documentation "live", run the following command:

pip install -e .[sphinx]
sphinx-build docs docs/_build/html

Then browse the HTML files in docs/_build/html to see the rendered documentation.

Inspiration

This project takes heavy inspiration from the Bootstrap v5 documenation.

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-examples-0.0.5.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

sphinx_examples-0.0.5-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-examples-0.0.5.tar.gz.

File metadata

  • Download URL: sphinx-examples-0.0.5.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.27.1

File hashes

Hashes for sphinx-examples-0.0.5.tar.gz
Algorithm Hash digest
SHA256 552772a5e6de97b6ca0930125f6272a9fb7b2d875afdc02c8e2fbec9eaf93ff4
MD5 9448f3367f514d1cdf73cb89791fc320
BLAKE2b-256 7719b5e920bbb6eecd4be19f0f7f796d72deecfe3988d675c6e703d05f2586de

See more details on using hashes here.

File details

Details for the file sphinx_examples-0.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_examples-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a10c744d65a79fa79637c8c814d5a5c473936a03590621b89d039e88d15ce322
MD5 4f2f8359fa3633e261687616bab56f87
BLAKE2b-256 0b2109f718443b36710f978d6f1c474ad86ae23e707790f9e0d9e6124320ec43

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