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

Uploaded Source

File details

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

File metadata

File hashes

Hashes for sphinxcontrib-wiki-0.4.0.tar.gz
Algorithm Hash digest
SHA256 4fc40c2ce3bfba0c430613d16952c736471b8cf2460379b780eede3d26c73dae
MD5 2474c8a34823db6f9f12c8e57fb4308e
BLAKE2b-256 057661f342ad17c9498d5ba67e6418c33aee3b558e6a626a4d93bbc5a72b9f11

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