Skip to main content

Assemble sections into wiki pages in sphinx documents

Project description

teststatus docstatus pypistatus

An extension for sphinx that allows wiki pages to be defined section by section and assembled on demand using two custom directives: wikisection, and wikipage, respectively. This is particularly useful for code documentation (although arbitrary sphinx documents can use the directives) by allowing external documentation files to be broken down to sections and placed in docstrings for corresponding portions of code.

To get started, install the package via PyPI, follow the docs and sample usage in the tests directory.

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-wiki-0.5.0.tar.gz (20.4 kB view details)

Uploaded Source

File details

Details for the file sphinxcontrib-wiki-0.5.0.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-wiki-0.5.0.tar.gz
Algorithm Hash digest
SHA256 6ff3fb141555e414f6ce2d486a4768ae9ceff1fcc4704dbedff61e3992338d8a
MD5 a9516677ba616ea58c18007b89364b67
BLAKE2b-256 fdb0974d1c91ea385bbf12dcb93918f25ec6fdd29e3a745688dc5b590a1fe674

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