Last change
on this file since 10279 was
10279,
checked in by nicolasmartin, 2 years ago
|
|
Various improvments for quick start guide
- implementation of Rtd theme (Read the Docs) with custom layout and style file
- add reviewed BibTeX entries for NEMO references with DOI (manuals, guide, development strategy)
- enhancement of bibliography management and configuration file for guide building
- standardisation of headings markup
- numerous edits
|
|
File size:
1.3 KB
|
| Line | |
|---|
| 1 | ################# |
|---|
| 2 | Quick Start Guide |
|---|
| 3 | ################# |
|---|
| 4 | |
|---|
| 5 | .. |
|---|
| 6 | For headings markup, this convention is recommended from Python’s Style Guide |
|---|
| 7 | # with overline, for parts |
|---|
| 8 | * with overline, for chapters |
|---|
| 9 | =, for sections |
|---|
| 10 | -, for subsections |
|---|
| 11 | ^, for subsubsections |
|---|
| 12 | ", for paragraphs |
|---|
| 13 | |
|---|
| 14 | 'global.rst' contains a list of common directives (roles, substitutions and URL links) |
|---|
| 15 | It is loaded for each file thanks to 'rst_epilog' setting in 'conf.py' |
|---|
| 16 | |
|---|
| 17 | .. toctree:: |
|---|
| 18 | :hidden: |
|---|
| 19 | |
|---|
| 20 | release_notes.rst |
|---|
| 21 | |
|---|
| 22 | .. toctree:: |
|---|
| 23 | :hidden: |
|---|
| 24 | :caption: Getting started |
|---|
| 25 | |
|---|
| 26 | install |
|---|
| 27 | configurations |
|---|
| 28 | test_cases |
|---|
| 29 | |
|---|
| 30 | .. toctree:: |
|---|
| 31 | :hidden: |
|---|
| 32 | :caption: Setup your configuration |
|---|
| 33 | |
|---|
| 34 | setup |
|---|
| 35 | diagnostics |
|---|
| 36 | tools |
|---|
| 37 | |
|---|
| 38 | .. toctree:: |
|---|
| 39 | :hidden: |
|---|
| 40 | :caption: Advanced use |
|---|
| 41 | |
|---|
| 42 | zooms |
|---|
| 43 | coarsening |
|---|
| 44 | coupling |
|---|
| 45 | assimilation |
|---|
| 46 | tracers |
|---|
| 47 | |
|---|
| 48 | .. toctree:: |
|---|
| 49 | :hidden: |
|---|
| 50 | :caption: Glossary |
|---|
| 51 | |
|---|
| 52 | definitions |
|---|
| 53 | |
|---|
| 54 | .. include:: readme.rst |
|---|
| 55 | |
|---|
| 56 | .. Next headings markup acording to readme.rst |
|---|
| 57 | |
|---|
| 58 | How to cite NEMO |
|---|
| 59 | ================ |
|---|
| 60 | |
|---|
| 61 | .. bibliography:: references.bib |
|---|
| 62 | :all: |
|---|
| 63 | :style: unsrt |
|---|
| 64 | :labelprefix: R |
|---|
| 65 | |
|---|
| 66 | Disclaimer |
|---|
| 67 | ========== |
|---|
| 68 | |
|---|
| 69 | The NEMO source code is freely available and distributed under CeCILL license |
|---|
| 70 | (GNU GPL compatible - see ``./LICENSE``). |
|---|
| 71 | |
|---|
| 72 | You can use, modify and/or redistribute the software under its terms, |
|---|
| 73 | but users are provided only with a limited warranty and the software's authors and |
|---|
| 74 | the successive licensor's have only limited liability. |
|---|
Note: See
TracBrowser
for help on using the repository browser.
