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


Download files

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

Source Distribution

sphinxcontrib-inherit-0.1.0.tar.gz (27.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinxcontrib_inherit-0.1.0-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

Details for the file sphinxcontrib-inherit-0.1.0.tar.gz.

File metadata

  • Download URL: sphinxcontrib-inherit-0.1.0.tar.gz
  • Upload date:
  • Size: 27.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.10.0 pkginfo/1.2.1 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.19.5 CPython/3.6.9

File hashes

Hashes for sphinxcontrib-inherit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 30f2788630f464adbcfda2dab559e83009e5e655b17d90ae2fb2d8edae8cde2a
MD5 83b6c565d9f105e9d7e9079611734641
BLAKE2b-256 81b823eff53dbac80f4efeba0f6a76183fb973e4c9cab0d818d4fa8c3501f0a2

See more details on using hashes here.

File details

Details for the file sphinxcontrib_inherit-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sphinxcontrib_inherit-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.10.0 pkginfo/1.2.1 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.19.5 CPython/3.6.9

File hashes

Hashes for sphinxcontrib_inherit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c150b3943327d87657d9a7bf3e93547e1168f0b9cd16641271b6c9140f6a2934
MD5 3807f3fe335cbc56b0e8b5b9ffb235af
BLAKE2b-256 bde44c2f13eaf85e83ffc08ecae451b571ff995f8704771a2ebdaa55bc84b4b5

See more details on using hashes here.

Supported by

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