Show More
| @@ -1,17 +1,16 b'' | |||||
| 1 | """Directives and roles for documenting traitlets config options. |
|
1 | """Directives and roles for documenting traitlets config options. | |
| 2 |
|
2 | |||
| 3 | :: |
|
3 | :: | |
| 4 |
|
4 | |||
| 5 | .. configtrait:: Application.log_datefmt |
|
5 | .. configtrait:: Application.log_datefmt | |
| 6 |
|
6 | |||
| 7 | Description goes here. |
|
7 | Description goes here. | |
| 8 |
|
8 | |||
| 9 | Cross reference like this: :configtrait:`Application.log_datefmt`. |
|
9 | Cross reference like this: :configtrait:`Application.log_datefmt`. | |
| 10 | """ |
|
10 | """ | |
| 11 | from sphinx.locale import l_ |
|
11 | ||
| 12 | from sphinx.util.docfields import Field |
|
|||
| 13 |
|
12 | |||
| 14 | def setup(app): |
|
13 | def setup(app): | |
| 15 | app.add_object_type('configtrait', 'configtrait', objname='Config option') |
|
14 | app.add_object_type('configtrait', 'configtrait', objname='Config option') | |
| 16 | metadata = {'parallel_read_safe': True, 'parallel_write_safe': True} |
|
15 | metadata = {'parallel_read_safe': True, 'parallel_write_safe': True} | |
| 17 | return metadata |
|
16 | return metadata | |
General Comments 0
You need to be logged in to leave comments.
Login now