Sphinx¶
Sphinx: Web Support provides the machinery to serves ones documentation through their web framework. implementation
Note
Sphinx: Web Support should be preferred over the information that follows.
Sphinx provides three means of incorporating ones documentation into ones web framework. A fourth method is considered whereby the Jinja2, the HTML builder provided by sphinx, is allowed to execute normally yet the output is decorated such that it may be consumed by a subsequent template engine.
| Source processed by Sphinx | Source processed by second engine | Final output |
{% block Jinja2 %}
{% block ENGINE %}
<html>
...
</html>
{% endblock ENGING %}
{% endblock Jinja2 %}
|
{% block ENGINE %}
<html>
...
</html>
{% endblock ENGING %}
|
<html>
...
</html>
|
The sphinx templates provided by Web-Templates support this embedding of Sphinx output into some other template engine. This is down by nesting the syntax of the second engine as comments within the syntax of the first. This is an experimental feature and may or may not work in all scenarios.