|
47 | 47 | The ``plot`` directive supports the following options: |
48 | 48 |
|
49 | 49 | format : {'python', 'doctest'} |
50 | | - The format of the input. |
| 50 | + The format of the input. If unset, the format is auto-detected. |
51 | 51 |
|
52 | 52 | include-source : bool |
53 | | - Whether to display the source code. The default can be changed |
54 | | - using the `plot_include_source` variable in :file:`conf.py`. |
| 53 | + Whether to display the source code. The default can be changed using |
| 54 | + the `plot_include_source` variable in :file:`conf.py` (which itself |
| 55 | + defaults to False). |
55 | 56 |
|
56 | 57 | encoding : str |
57 | 58 | If this source file is in a non-UTF8 or non-ASCII encoding, the |
|
86 | 87 | The plot directive has the following configuration options: |
87 | 88 |
|
88 | 89 | plot_include_source |
89 | | - Default value for the include-source option |
| 90 | + Default value for the include-source option (default: False). |
90 | 91 |
|
91 | 92 | plot_html_show_source_link |
92 | | - Whether to show a link to the source in HTML. |
| 93 | + Whether to show a link to the source in HTML (default: True). |
93 | 94 |
|
94 | 95 | plot_pre_code |
95 | | - Code that should be executed before each plot. If not specified or None |
| 96 | + Code that should be executed before each plot. If None (the default), |
96 | 97 | it will default to a string containing:: |
97 | 98 |
|
98 | 99 | import numpy as np |
99 | 100 | from matplotlib import pyplot as plt |
100 | 101 |
|
101 | 102 | plot_basedir |
102 | | - Base directory, to which ``plot::`` file names are relative |
103 | | - to. (If None or empty, file names are relative to the |
104 | | - directory where the file containing the directive is.) |
| 103 | + Base directory, to which ``plot::`` file names are relative to. |
| 104 | + If None or empty (the default), file names are relative to the |
| 105 | + directory where the file containing the directive is. |
105 | 106 |
|
106 | 107 | plot_formats |
107 | | - File formats to generate. List of tuples or strings:: |
| 108 | + File formats to generate (default: ['png', 'hires.png', 'pdf']). |
| 109 | + List of tuples or strings:: |
108 | 110 |
|
109 | 111 | [(suffix, dpi), suffix, ...] |
110 | 112 |
|
|
114 | 116 | suffix:dpi,suffix:dpi, ... |
115 | 117 |
|
116 | 118 | plot_html_show_formats |
117 | | - Whether to show links to the files in HTML. |
| 119 | + Whether to show links to the files in HTML (default: True). |
118 | 120 |
|
119 | 121 | plot_rcparams |
120 | 122 | A dictionary containing any non-standard rcParams that should |
121 | | - be applied before each plot. |
| 123 | + be applied before each plot (default: {}). |
122 | 124 |
|
123 | 125 | plot_apply_rcparams |
124 | 126 | By default, rcParams are applied when ``:context:`` option is not used |
125 | | - in a plot directive. This configuration option overrides this behavior |
126 | | - and applies rcParams before each plot. |
| 127 | + in a plot directive. If set, this configuration option overrides this |
| 128 | + behavior and applies rcParams before each plot. |
127 | 129 |
|
128 | 130 | plot_working_directory |
129 | 131 | By default, the working directory will be changed to the directory of |
|
0 commit comments