Describe the bug
A clear and concise description of what the bug is.
I am using the following extensions to build my documentation with sphinx
Sphinx v7.0.1
Sphinx-needs v1.2.2
sphinx-makrdown-buidler v0.6.6
sphinx-rtd-theme v1.3.0
When I try to have a table inside of the needs as shown below, the markdown builder does not format the table correctly for it to render.
======================
Test Image With Target
======================
.. image:: /static/markdown.png
:target: https://github.com/liran-funaro/sphinx-markdown-builder
Download :download:`this example image </static/markdown.png>`.
.. req:: Some requirement
:id: REQ_1
.. list-table::
:header-rows: 1
:class: tight-table
* - #
- Action
- Expected Result
- Notes
- Result
* - 1
- Start
- Test should Start
- More Notes
- No result
The same works fine with the HTML builder.
Do I need to do something different for the markdown builder? How can I fix this?
EDIT:
I performed some tests in sphinx-markdown-builder to see how I can use the .. list-table:: in the .rst file. I tried it in two different approaches.
Describe the bug A clear and concise description of what the bug is.
I am using the following extensions to build my documentation with sphinx
The same works fine with the HTML builder.
Do I need to do something different for the markdown builder? How can I fix this?
EDIT:
I performed some tests in sphinx-markdown-builder to see how I can use the
.. list-table::in the.rstfile. I tried it in two different approaches.I had the
.. list-table::nested in one of the needs. I have attached the diff patch - test_nested_list_table.PATCH and the markdown file: image-target.mdI had the
.. list-table::as an independent entity in the file (non-nested):test_list_table.PATCH and the markdown file:
image-target.md
This time I see the right table format.
To Reproduce Create an rst file like above Convert it to markdown with this plugin See similar output in markdown Expected behavior
The nested list-tablke should be displayed inside the table for the
SWRQ_SYSTEM_MONITOR_422requirementEnvironment (please complete the following information):
OS: Ubuntu Version: 22.04 Additional context Add any other context about the problem here.
Expected behavior A clear and concise description of what you expected to happen.
Environment (please complete the following information):
Additional context Add any other context about the problem here.
I have also filed a similar issue with sphinx-needs https://github.com/useblocks/sphinx-needs/issues/1161