Assemble sections into wiki pages in sphinx documents
Project description
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.2.3.tar.gz
(19.9 kB
view details)
File details
Details for the file sphinxcontrib-wiki-0.2.3.tar.gz
.
File metadata
- Download URL: sphinxcontrib-wiki-0.2.3.tar.gz
- Upload date:
- Size: 19.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25b0a99fe55c5f756d2f3bdb45961b6264c7abfc41e84c3e959f8620d39b9b9a |
|
MD5 | 305a18ccb1f2a69706771ffbb99b989a |
|
BLAKE2b-256 | 8197c827a03572f9b10abf587b2e6553c3427fa6fce98504501cef8a6eaa74fb |