Skip to content
Snippets Groups Projects
Unverified Commit 9edd1cee authored by Chris Holdgraf's avatar Chris Holdgraf Committed by GitHub
Browse files

:books: DOCS: adding a title to our example tables (#1084)

parent 708f5201
No related branches found
No related tags found
No related merge requests found
...@@ -171,7 +171,7 @@ We just have to use the title of the admonition as target: ...@@ -171,7 +171,7 @@ We just have to use the title of the admonition as target:
[Go to the fish!](markdown-fig) [Go to the fish!](markdown-fig)
``` ```
(figures:referencing)=
## Referencing figures ## Referencing figures
You can then refer to your figures by using the `{ref}` role or Markdown style references like: You can then refer to your figures by using the `{ref}` role or Markdown style references like:
...@@ -186,6 +186,7 @@ which will replace the reference with the figure caption like so: ...@@ -186,6 +186,7 @@ which will replace the reference with the figure caption like so:
- {ref}`directive-fig` - {ref}`directive-fig`
- [](markdown-fig) - [](markdown-fig)
(figures:numref)=
### Numbered references ### Numbered references
Another convenient way to create cross-references is with the `{numref}` role, Another convenient way to create cross-references is with the `{numref}` role,
......
...@@ -329,7 +329,7 @@ Another alternative is to use Markdown syntax: ...@@ -329,7 +329,7 @@ Another alternative is to use Markdown syntax:
- 2744 - 2744
``` ```
```` ````
- ```{list-table} - ```{list-table} My table title
:header-rows: 1 :header-rows: 1
:name: example-table :name: example-table
...@@ -341,7 +341,7 @@ Another alternative is to use Markdown syntax: ...@@ -341,7 +341,7 @@ Another alternative is to use Markdown syntax:
- 2744 - 2744
``` ```
* - ````md * - ````md
```{list-table} title ```{list-table} Table title
:header-rows: 1 :header-rows: 1
* - Col1 * - Col1
...@@ -353,7 +353,7 @@ Another alternative is to use Markdown syntax: ...@@ -353,7 +353,7 @@ Another alternative is to use Markdown syntax:
``` ```
```` ````
- ````md - ````md
```{list-table} Table with a title ```{list-table} This table title
:header-rows: 1 :header-rows: 1
* - Training * - Training
...@@ -364,7 +364,7 @@ Another alternative is to use Markdown syntax: ...@@ -364,7 +364,7 @@ Another alternative is to use Markdown syntax:
- 2744 - 2744
``` ```
```` ````
- ```{list-table} Table with a title - ```{list-table} This table title
:header-rows: 1 :header-rows: 1
* - Training * - Training
...@@ -379,7 +379,10 @@ Another alternative is to use Markdown syntax: ...@@ -379,7 +379,10 @@ Another alternative is to use Markdown syntax:
### Referencing tables ### Referencing tables
```{note} ```{note}
To add a label to your table simply include a `:name:` parameter followed by the label of your table. See example above. In order to [reference a table](figures:referencing) you must add a label to it.
To add a label to your table simply include a `:name:` parameter followed by the label of your table.
In order to add a [numbered reference](figures:numref), you
must also include a table title. See example above.
``` ```
``````{list-table} ``````{list-table}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment