Skip to main content

A Sphinx extention with complimentary features

Project description

Documentation Status

A collection of directives to compliment those provided by Sphinx

Background

On occasion the features offered by Sphinx and its various extention packages do not provide all of the functionality necessary for authorisng a document. Fortunately Sphinx is readily extended and one may implement the features one requires; after traversing the Sphinx and Docutils documentation.

Purpose

This package hopes to collect such efforts into a common package. Additionally, by documenting such efforts, the package hopes to assist other extention writers in contributing to its development.

Installation

The package can be installed directly through pip

pip install Sphinx-Nosejob

Usage

Within ones Sphinx configuration file, source/conf.py, include either all of the festures provided by Sphinx-Nosejob

extensions = [...
    'sphinxcontrib.nosejob',
    ...]

Alternatively one may selectively include a subset of the provided features by explicitly specifying them

extensions = [...
    'sphinxcontrib.nosejob.FEATURE(S)',
    ...]

Documentation

Documentation are available at Gitlab.io.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for Sphinx-Nosejob, version 0.0.0.post0
Filename, size File type Python version Upload date Hashes
Filename, size Sphinx_Nosejob-0.0.0.post0-py3-none-any.whl (17.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page