Skip to main content

A Sphinx extension that allows documentation to be created in a modular way.

Project description

Documentation Inheritance for Sphinx

The sphinxcontrib-inherit package is an extension to Sphinx. It allows you to extend existing sphinx documentation without needing to add any directives or hooks to the original document. It is ideal for use in projects that make extensive use of pluggable modules, and require different documentation to be generated depending on which modules are enabled.

This extension was inspired by the sphinxcontrib-inheritance package, but takes a different approach on how the inheritance is implemented.

Installation

pip3 install sphinxcontrib-inherit

Project details


Release history Release notifications

Download files

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

Files for sphinxcontrib-inherit, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_inherit-0.1.0-py3-none-any.whl (16.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size sphinxcontrib-inherit-0.1.0.tar.gz (27.0 kB) File type Source Python version None 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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page