Changeset 274f9ef in flex_extract.git for documentation/Sphinx/source/index.rst


Ignore:
Timestamp:
Oct 22, 2018, 11:44:47 AM (6 years ago)
Author:
Anne Philipp <anne.philipp@…>
Branches:
master, ctbto, dev
Children:
db27c09
Parents:
708c667
Message:

Converted docstrings to numpy style and build first structure for sphinxdocumentation (incl API)

File:
1 edited

Legend:

Unmodified
Added
Removed

  • documentation/Sphinx/source/index.rst

    r708c667 r274f9ef  
    44   contain the root `toctree` directive.
    55
    6 Welcome to flex_extract's documentation!
    7 ========================================
     6Welcome to flex_extract's user documentation!
     7=============================================
     8
     9flex_extract is a software to retrieve meteorological fields from the European Centre for Medium-Range Weather Forecasts (ECMWF) Mars archive to server as input files for the FLEXTRA/FLEXPART Atmospheric Transport Modelling system.
     10
     11
     12.. The scripts can be 1) executed locally using the ECMWF WebMARS interface, or 2) on the ECMWF member
     13.. state gateway server or HPC facility using the ecaccess software package. As another option the scripts can 3)
     14.. also be triggered using ecflow scheduling software used by ECMWF for data dissemination.
     15
     16All required second party software and libraries used within flex_extract is open source and free of charge.
     17
    818.. raw:: html
    919
    … …  
    8797
    8898.. toctree::
    89    :maxdepth: 2
     99   :maxdepth: 3
    90100   :caption: Table of Contents:
    91101
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG