Usage#
Skeleton usage documentation.
Installation#
Install Skeleton directly from pypi using pip:
pip install sphinxcontrib-skeleton
To activate the extension you must add it to your conf.py
file:
# docs/conf.py
extensions = [
...
"sphinxcontrib.skeleton",
...
]
Usage#
Here we demonstrate how one could display the Skeleton roles directives.
demo-directive#
The package is providing a demo-directive
:
.. demo-directive:: This is a demo directive.
```{demo-directive} This is a demo directive.
```
And here is the result :
This is a demo directive.
demo-role#
The package is providing a demo-role
:
I'm an :demo-role:`demo` role.
I'm an {demo-role}`demo` role.
And here is the result :
I’m an demo role.