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.3.0.tar.gz (20.0 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for sphinxcontrib-wiki-0.3.0.tar.gz
Algorithm Hash digest
SHA256 1a61fd14d679ab00684fe27f4205c96426a9683a1aeb83548a555f3168e586f2
MD5 4998da86b714c2590c6da7f1478433ad
BLAKE2b-256 b0ee6050f49d0d043ec6d369dfe3cb703efbed2eb9c4634a9d3d32dd661a0086

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