DOC: add a matrix style #502
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a
matrix
style to the stylesheet that formats a table to look like a matrix.Heavily based on the style used by matrepr, but with some tweaks to make it work within the Sphinx/Bootstrap styles.
Usage
Add a
:class: matrix
directive to any table. This is stackable with other classes, for example
:class: inline matrix
includes both inline and matrix styles.If the matrix has row indices, then also add
:stub-columns: 1
to mark the leftmost column as a header. This way the leftmost column is styled as indices, but more importantly the matrix border will be in the correct place (i.e. the indices are outside the matrix).Example:
Effect
Becomes
Closes #496