phpDocumentor / phpDocumentor/guides
[FEATURE] Support Sphinx's table spans
Open
Nobody has claimed this yet.
feature
triage
- Dominant language
- PHP
- Stars
- 36
- Forks
- 22
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 24
Description
Feature request
The table spans are currently not supported, neither for grid tables nor for simple tables syntax.
Simple table syntax: See (Sphinx docs link):
===== ===== ======
Inputs Output
------------ ------
A B A or B
===== ===== ======
False False False
True False True
False True True
True True True
===== ===== ======
Produces currently:
Grid table syntax: See (Sphinx docs link):
+--------------+----------+-----------+-----------+
| row 1, col 1 | column 2 | column 3 | column 4 |
+--------------+----------+-----------+-----------+
| row 2 | |
+--------------+----------+-----------+-----------+
| row 3 | | | |
+--------------+----------+-----------+-----------+
Produces currently:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Use the simple-table and grid-table examples in the issue as fixtures while locating the documentation table parser entry point and its existing tests. Done means both syntaxes parse their spanning cells correctly, with coverage for the examples shown.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100