This release is a pre-release and may not be stable for production use.
Introduction
horae.sphinx.grok is an extension for the Sphinx documentation generator. It provides two new autodoc directives autogrok and autogrokfunction. By using those directives instead of the stock autoclass and autofunction ones additional grok specific information is given about the class or function.
If the autogrok directive is as an example used on the following class definition:
class ExampleAdapter(grok.Adapter):
"""
An adapter demonstrating the autogrok directive
"""
grok.context(IAdaptee)
grok.implements(ISomeFunctionality)
grok.name('example')
The reStructuredText output of the docstring would look like this:
An adapter demonstrating the autogrok directive
:context:
:class:`IAdaptee`
:implements:
:class:`ISomeFunctionality`
:name:
example
The autogrokfunction is doing the same for functions:
@grok.adapter(IAdaptee, name="example")
@grok.implementer(ISomeFunctionality)
def example_adapter_factory(context):
"""
An adapter factory demonstrating the autogrokfunction directive
"""
return ExampleAdapter(context)
Which would result in:
An adapter factory demonstrating the autogrokfunction directive
:context:
:class:`IAdaptee`
:implements:
:class:`ISomeFunctionality`
:name:
example
Changelog
1.0a1 (2012-01-16)
Initial release
Metadata
Release files for horae.sphinx.grok 1.0a1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| horae.sphinx.grok-1.0a1.tar.gz | 3.1 kB | Without provenance | Details for horae.sphinx.grok-1.0a1.tar.gz |
Release files / horae.sphinx.grok-1.0a1.tar.gz
| Download URL | horae.sphinx.grok-1.0a1.tar.gz |
|---|---|
| Size | 3.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
478f8746221944dd9919ee7a802630f1f928e6f5fde4d87f3f0049d0383fd898
|
|
BLAKE2b-256 checksum How to use checksums |
f8aa9cd02266c6e97e49af6cb68e71658dbbae4fbfca8195aaecf4389c842c24
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for horae.sphinx.grok 1.0a1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.