A compliment of features to those provided by Sphinx that one found useful while documenting their source code.
- API-Doc
An alternative to the sphinx API doc function that tries to support an output structure that maps more closely to the code base and eases maintenance. This was written to be backwards compatible with the original implementation.
- Epilog
This provides a “universal” epilog for sphinx for authors working on multiple projects that need a common set of replacements. The intention is to provide a corresponding glossary module.
Background
On occasion the features offered by Sphinx and its various extention packages do not provide all of the functionality necessary for authorisng a document. Fortunately Sphinx is readily extended and one may implement the features one requires; after traversing the Sphinx and Docutils documentation.
Purpose
This package hopes to collect such efforts into a common package. Additionally, by documenting such efforts, the package hopes to assist other extention writers in contributing to its development.
Installation
The package can be installed directly through pip
pip install Sphinx-Nosejob
Usage
Within ones Sphinx configuration file, source/conf.py, include either all of the festures provided by Sphinx-Nosejob
extensions = [...
'sphinxcontrib.nosejob',
...]
Alternatively one may selectively include a subset of the provided features by explicitly specifying them
extensions = [...
'sphinxcontrib.nosejob.FEATURE',
...]
Documentation
Documentation is available at Gitlab.io.
1 maintainer
Metadata
1 maintainer
Release files for Sphinx-Nosejob 0.0.1.post0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| Sphinx_Nosejob-0.0.1.post0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / Sphinx_Nosejob-0.0.1.post0-py3-none-any.whl
| Download URL | Sphinx_Nosejob-0.0.1.post0-py3-none-any.whl |
|---|---|
| Size | 43.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
438d30b09fafabb9f9e47fa820876de43ef1c1f659d3dce9e08be6f08a8e55ad
|
|
BLAKE2b-256 checksum How to use checksums |
a85f6efa9ed9d7bb6661e81ab2860c446e73681744b48f004f60b34b1447ac4c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/2.0.0 pkginfo/1.4.2 requests/2.24.0 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.3
|
