Conversation
JuReMq
force-pushed
the
264-update-to-latest-sphinx-needs-version
branch
from
a54bd98 to
0f6ef93
Compare
JuReMq
force-pushed
the
264-update-to-latest-sphinx-needs-version
branch
from
0f6ef93 to
ab8baab
Compare
Test Results191 tests 191 ✅ 3m 52s ⏱️ Results for commit ab8baab. |
Automatically generated by python-semantic-release
| source_suffix = extension_configs["source_suffix"] | ||
|
|
||
| # Import default SPL sphinx-needs configuration | ||
| needs_from_toml = ".venv/Lib/site-packages/spl_core/report_generation/ubproject.toml" |
There was a problem hiding this comment.
This is a Windows only path (Lib/site-packages). On Linux/macOS it would be lib/pythonX.Y/site-packages. It should be resolved dynamically, e.g.:
from importlib.resources import files
needs_from_toml = str(files("spl_core.report_generation").joinpath("ubproject.toml"))| needs_global_options = SplSphinx.default_needs_global_options | ||
|
|
||
| # Provide all config values to jinja | ||
| html_context = { |
There was a problem hiding this comment.
The html_context is updated based on files known to spl-core (autoconf and sphinx build config).
Because these files and the environment variables are generated by spl-core it makes sense to move this logic to the spl-core sphinx report generation module.
See a similar example here: https://github.com/cuinixam/SPLed/blob/33524bc316be5682618ed90523be4d5883c6f1b8/conf.py#L45
| from sphinx_needs.need_item import NeedItem, NeedPartItem | ||
|
|
||
|
|
||
| def sple_tr_link( |
There was a problem hiding this comment.
Is there no way to keep the name of this method tr_link and use it to override the default sphinx needs tr_link implementation?
If we change the name, one must change in all test files in all SPLs from tr_link to sple_tr_link.
| { option = "fulfills", incoming = "is fulfilled by", outgoing = "fulfills" }, | ||
| { option = "refines", incoming = "is refined by", outgoing = "refines" }, | ||
| { option = "implements", incoming = "is implemented by", outgoing = "implements" }, | ||
| { option = "results", incoming = "results from", outgoing = "results" }, |
There was a problem hiding this comment.
Why did we change from is resulted from to results from?
This change requires that we update the test_report_template.txt in all SPLs.
2 participants
No description provided.