Subversion URL: http://proj.badc.rl.ac.uk/svn/exarch/CCCC/trunk/doc/build/html/_sources/index.txt@328
| Revision 328,
1.7 KB
checked in by mjuckes, 6 years ago
(diff) |
|
Extended documentation
|
| Line | |
|---|
| 1 | .. ceda-cc documentation master file, created by |
|---|
| 2 | sphinx-quickstart on Wed Mar 4 10:21:58 2015. |
|---|
| 3 | You can adapt this file completely to your liking, but it should at least |
|---|
| 4 | contain the root `toctree` directive. |
|---|
| 5 | |
|---|
| 6 | The ceda-cc file compliance checker: technical documentation |
|---|
| 7 | =================================== |
|---|
| 8 | |
|---|
| 9 | .. toctree:: |
|---|
| 10 | :maxdepth: 2 |
|---|
| 11 | |
|---|
| 12 | Usage (ccinit) |
|---|
| 13 | =============== |
|---|
| 14 | |
|---|
| 15 | Calling options |
|---|
| 16 | --------------- |
|---|
| 17 | |
|---|
| 18 | ============================================= ========================================================== |
|---|
| 19 | Command line Description |
|---|
| 20 | ============================================= ========================================================== |
|---|
| 21 | ceda-cc -p <project> -D <directory> [..] check all data in directory tree under specified directory |
|---|
| 22 | ceda-cc -p <project> -d <directory> [..] check all data in specified directory |
|---|
| 23 | ceda-cc -p <project> -f <file> [..] check a single file |
|---|
| 24 | ceda-cc --sum <log file directory> [..] create an overview of results |
|---|
| 25 | ceda-cc --copy-config <target diectory> [..] copy configuration files to a new directory |
|---|
| 26 | ============================================= ========================================================== |
|---|
| 27 | |
|---|
| 28 | .. automodule:: ccinit |
|---|
| 29 | :members: |
|---|
| 30 | |
|---|
| 31 | c4 |
|---|
| 32 | =============== |
|---|
| 33 | |
|---|
| 34 | .. automodule:: c4 |
|---|
| 35 | :members: |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | c4_run |
|---|
| 39 | =============== |
|---|
| 40 | |
|---|
| 41 | .. automodule:: c4_run |
|---|
| 42 | :members: |
|---|
| 43 | |
|---|
| 44 | |
|---|
| 45 | config_c4 |
|---|
| 46 | =============== |
|---|
| 47 | |
|---|
| 48 | .. automodule:: config_c4 |
|---|
| 49 | :members: |
|---|
| 50 | |
|---|
| 51 | |
|---|
| 52 | utils_c4 |
|---|
| 53 | =============== |
|---|
| 54 | |
|---|
| 55 | .. automodule:: utils_c4 |
|---|
| 56 | :show-inheritance: |
|---|
| 57 | :inherited-members: |
|---|
| 58 | :members: |
|---|
| 59 | |
|---|
| 60 | xceptions |
|---|
| 61 | ========= |
|---|
| 62 | |
|---|
| 63 | .. automodule:: xceptions |
|---|
| 64 | :members: |
|---|
| 65 | |
|---|
| 66 | Indices and tables |
|---|
| 67 | ================== |
|---|
| 68 | |
|---|
| 69 | * :ref:`genindex` |
|---|
| 70 | * :ref:`modindex` |
|---|
| 71 | * :ref:`search` |
|---|
| 72 | |
|---|
Note: See
TracBrowser
for help on using the repository browser.
