Changeset 1111
- Timestamp:
- Sep 12, 2012 1:18:40 PM (11 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
specdomain/trunk/src/specdomain/doc/style_guide.rst
r1109 r1111 184 184 The following items should be included, preferrably in this order: 185 185 186 187 188 189 190 191 192 193 186 * AUTHOR(S): 187 * CREATION DATE: 188 * COPYRIGHT: 189 * LICENSE:: 190 * VERSION:: 191 * CHANGE LOG: 192 * TO DO: 193 * KNOWN BUGS: 194 194 195 195 See the below example for more details on each of these items. … … 270 270 CREATION DATE: 271 271 272 YYYY /MM/DD272 YYYY-MM-DD 273 273 274 274 COPYRIGHT: … … 338 338 CHANGE LOG: 339 339 340 YYYY /MM/DD (AS):340 YYYY-MM-DD (AS): 341 341 342 342 - created first version of this macro. 343 343 - tested on a dummy SPEC version not connected to a diffractometer. 344 344 345 YYYY /MM/DD (AS):345 YYYY-MM-DD (AS): 346 346 347 347 - added a new macro definition: :spec:def:`new_macro` to display the status. … … 563 563 564 564 The documentation for such a collection should be in the form of normal ReST 565 files (``*.rst``), residing in the same directory with the macro collection. There566 is no way of automatically including this information in the global documents 567 yet, so it will need to be added manually somewhere in the documentation tree568 (at least in the global ``index.rst`` file or some other file that is included 569 f rom the global scope).570 565 files (``*.rst``), residing in the same directory with the macro collection. 566 There is no way of automatically including this information in the global 567 documents yet, so it will need to be added manually somewhere in the 568 documentation tree (at least in the global ``index.rst`` file or some other 569 file that is included from the global scope). 570
Note: See TracChangeset
for help on using the changeset viewer.