Comments (6)
how about https://pypi.org/project/mlx.traceability/ 😉
check the readme for details of installing and your makefile/conf.py : pip install mlx.traceability
from sphinx-traceability-extension.
The item_matrix
directive already generates a traceability matrix. It is not bidimensional as your example, but a two column table with related items. Nevertheless, it can be used for the same purpose.
If you build the example document you can see how traceability matrices are created.
from sphinx-traceability-extension.
I think this feature is available in melexis fork: https://github.com/melexis/sphinx-traceability-extension#2d-matrix-of-documentation-items
Example: https://melexis.github.io/sphinx-traceability-extension/#item-2d-matrix
implemented in melexis#40 and melexis#41
backporting could be more difficult as the data organization is class based in melexis fork...
from sphinx-traceability-extension.
@SteinHeselmans Nice work. Is it possible to get the data out e.g. that it can be represented differently in some custom website as well? Could you point to the sources of the data organization? (If operations are executed on the data it makes totally sense to use classes. If no operation needs to be executed on the data Namedtuples could be good choices for data representation as well.)
from sphinx-traceability-extension.
There is no explicit way to change the representation of the directives in melexis fork. I know the origin ociu-version has a template for representing an item, but that support is removed in the melexis fork. So also the item-2d-matrix is not templated... I am not an html expert myself, but some customization should be possible with css/javascript, probably. A colleague of mine is using some javascript on top to color the items and links to them based on their name...
There is operations on the data in melexis fork: if a forward link is created from item a to item b, the reverse link from item b to item a is also added. If item b does not exist yet in the collection, a placeholder for it is added. In the end no placeholders should exist (broken links). Hiding these things in classes (traceable_item.py
and traceable_collection.py
) makes the whole thing better to read, unit test, and maintain. See readme, test cases and inline code docs for more details on data organization in melexis fork. I will push the use of classes even further in our melexis fork, as the CCM values are way too high now.
from sphinx-traceability-extension.
I know the origin ociu-version has a template for representing an item, but that support is removed in the melexis fork. So also the item-2d-matrix is not templated... I am not an html expert myself, but some customization should be possible with css/javascript, probably.
As far as I can remember the template was somehow limited anyway. I prefer css/javascript.
There is operations on the data in melexis fork: if a forward link is created from item a to item b, the reverse link from item b to item a is also added. If item b does not exist yet in the collection, a placeholder for it is added. In the end no placeholders should exist (broken links).
Nice (and definitely required) feature!
Hiding these things in classes (traceable_item.py and traceable_collection.py) makes the whole thing better to read, unit test, and maintain. See readme, test cases and inline code docs for more details on data organization in melexis fork.
Would have been my design choice as well. As soon as requirement traceability for our Python source code would get required I consider to use your fork. Would be nice to beeing able to install your fork via PyPi. But tagged versions on github are fine for me as well.
I will push the use of classes even further in our melexis fork, as the CCM values are way too high now.
Thx in advance 😉
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
- Item templates HOT 1
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.