Comments (1)
Finally the example/default template had to be slightly different, in order to be correctly rendered:
{{ id }}
{%- if caption %}
**{{ caption }}**
{% endif %}
{{ content|indent(4) }}
Multi-line strings have to be explicitly indented, and caption treated as optional with if statements. Input data (id, caption, content...) is exactly the same used internally to store item information.
A lot has to be written on this topic... Templating is definitely not easy, extreme care has to be taken and Jinja2 templating well understood. Will try to explain it further in the README file and make some impressing examples (as the results can be absolutely amazing :)). As a summary, Instead of giving the traceabiity extension more power to handle templates, I decided to keep it as simple as possible, and give the user full freedom in the template, giving as input all the item information. A user can do magic just within one template.
from sphinx-traceability-extension.
Related Issues (17)
- Make relationship options work HOT 5
- List/table titles not working HOT 2
- Item matrix templates HOT 1
- If no traceability directives are used, the sphinx build fails HOT 1
- Console traceability debug output HOT 1
- Item template: cannot display automatic reverse relationships HOT 2
- Newline not supported in :trace: relationships
- Incompatibility with .. only (and .. ifconfig) HOT 2
- Warnings don't display line number information HOT 1
- sphinx.util.compat.Directive is deprecated and will be removed in Sphinx 1.7 HOT 2
- Consider adding the sphinx-extension GitHub topic HOT 1
- How to add extension? HOT 5
- Missing setup.py HOT 1
- Matrix sources on same line in PDF HOT 4
- Directives in docstrings possible? HOT 2
- Requirement Traceability Matrix HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sphinx-traceability-extension.