Changeset 274f9ef in flex_extract.git for documentation/Sphinx/build/html/_sources


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)

Location:
documentation/Sphinx/build/html/_sources
Files:
17 added
8 edited

Legend:

Unmodified
Added
Removed

  • documentation/Sphinx/build/html/_sources/api.rst.txt

    r708c667 r274f9ef  
    22============================
    33
     4.. contents::
     5    :local:
     6   
     7Porgrams
     8--------
     9
     10install
     11*******
     12
     13.. automodule:: install
     14    :members:
     15   
     16submit
     17******
     18
     19.. automodule:: submit
     20    :members:
     21   
     22Classes
     23-------
     24
     25ControlFile
     26***********
     27
     28.. automodule:: ControlFile
     29    :members:
     30   
     31EcFlexpart
     32**********
     33
     34.. automodule:: EcFlexpart
     35    :members:
     36   
     37GribTools
     38*********
     39
     40.. automodule:: GribTools
     41    :members:
     42
     43MarsRetrieval
     44*************
     45
     46.. automodule:: MarsRetrieval
     47    :members:
     48
     49UioFiles
     50********
     51
     52.. automodule:: UioFiles
     53    :members:
     54
     55
     56
     57Modules
     58-------
     59
     60get_mars_data
     61*************
     62
     63.. automodule:: get_mars_data
     64    :members:
     65 
     66prepare_flexpart
     67****************
     68
     69.. automodule:: prepare_flexpart
     70    :members:   
     71   
     72tools
     73*****
     74
     75.. automodule:: tools
     76    :members:
     77
     78disaggregation
     79**************   
     80   
    481.. automodule:: disaggregation
    582    :members:

  • documentation/Sphinx/build/html/_sources/downloads.rst.txt

    r708c667 r274f9ef  
    55 
    66    UNDER CONSTRUCTION
     7   
     8.. toctree::
     9    :hidden:
     10    :maxdepth: 2
     11   
     12    downloads/tar_balls
     13    downloads/git_repo
     14    downloads/history_changes
     15   

  • documentation/Sphinx/build/html/_sources/index.rst.txt

    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
     18
    819.. raw:: html
    920
    … …  
    8798
    8899.. toctree::
    89    :maxdepth: 2
     100   :maxdepth: 3
    90101   :caption: Table of Contents:
    91102

  • documentation/Sphinx/build/html/_sources/installation.rst.txt

    r708c667 r274f9ef  
    11Installation
    22============
    3 
    4 Describe installation process flex_extract ....
    53 
    64    UNDER CONSTRUCTION
     5   
     6.. toctree::
     7    :hidden:
     8    :maxdepth: 2
     9   
     10    installation/requirements
     11    installation/oper_modes
     12    installation/test_install
     13
     14
     15   

  • documentation/Sphinx/build/html/_sources/program_structure.rst.txt

    r708c667 r274f9ef  
    55 
    66    UNDER CONSTRUCTION
     7   
     8.. toctree::
     9    :hidden:
     10    :maxdepth: 2
     11   
     12    program_structure/prog_overview
     13    program_structure/prog_components
     14    program_structure/prog_flow

  • documentation/Sphinx/build/html/_sources/requirements.rst.txt

    r708c667 r274f9ef  
    22============
    33
    4 Describe the requirements to use flex_extract ....
    54 
    65    UNDER CONSTRUCTION
     6   

  • documentation/Sphinx/build/html/_sources/support.rst.txt

    r708c667 r274f9ef  
    22=======
    33
    4 Describe support options ....
    54 
    65    UNDER CONSTRUCTION
     6   
     7   
     8.. toctree::
     9    :hidden:
     10    :maxdepth: 2
     11   
     12    support/ticket_system
     13    support/mailing_list
     14    support/known_bugs_issues
     15    support/faq
     16       

  • documentation/Sphinx/build/html/_sources/user_guide.rst.txt

    r708c667 r274f9ef  
    11User Guide
    22==========
    3 
    4 Describe using flex_extract ....
    53 
    64    UNDER CONSTRUCTION
     5   
     6.. toctree::
     7    :hidden:
     8    :maxdepth: 2
     9   
     10    user_guide/how_to
     11    user_guide/control_templates
     12   
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG