Code Monkey home page Code Monkey logo

enmap-box-documentation's Introduction

EnMAP-Box Documentation

This repository contains the EnMAP-Box Documentation hosted in https://enmap-box.readthedocs.io

Requirements

The packages in requirements.txt need to be installed.

Maintenance scripts in /scripts may require additional packages from PyQGIS and the EnMAP-Box source code. They may require that:

  • a PyQGIS environment is available, i.e. you can run import qgis

  • the EnMAP-Box source code repository (enmap-box) is either

    a) installed into the same folder

    <repositories>/enmap-box
                  /enmap-box-documentation
    

    or

    b) specified by the environmental variable ENMAPBOX_REPO=<repositories>/enmap-box

Branching

The main branch contains corresponds to the develop branch of the EnMAP-Box source code ( will be changed to main after the EnMAP-Box source code to github.)

Release branches, e.g. release_3.10 contain the documentation related to the corresponding EnMAP-Box versions as they are released in the QGIS plugin repository.

Files and Folders

Folder Content
source Documentation files (*.rst)
scripts Maintenance scripts, e.g. to generate *.rst files
snippets Python snippets, e.g. to create widgets for screenshots

Build the documentation

  • open a bash shell and run ./scripts/create_docs.sh (windows/linux bash shell), or
  • run (linux) make html, or (windows) make.bat html.

enmap-box-documentation's People

Contributors

janzandr avatar jakimowb avatar henridierkes avatar thielfab avatar florian-katerndahl avatar hdaemp avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.