This repository contains the EnMAP-Box Documentation hosted in https://enmap-box.readthedocs.io
The packages in requirements.txt
need to be installed:
pip install --upgrade --user -r https://raw.githubusercontent.com/EnMAP-Box/enmap-box-documentation/main/requirements.txt
Maintenance scripts in /scripts
may require additional packages from PyQGIS and the EnMAP-Box source code.
They may require that:
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
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.
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 |
Everyone can contribute to this documentation using git pull-requests. If you never have used git before, we recommend to read a basic git tutorial first, e.g. https://rogerdudler.github.io/git-guide/ or https://github.com/git-guides.
Create a fork
of this repository (hereafter referred as enmap-box-documentation-fork
).
Clone & checkout your fork on your local computer:
git clone https://github.com/mygithubaccount/enmap-box-documentation-fork.git
requirements.txt
are installed to your python environment, e.g. running
python -m pip install -r requirements.txt
Change the EnMAP-Box documentation.
*.rst
files to /source/usr_section/application_tutorials
Inspect your changes in a browser:
make html
, or (windows) make.bat html
to create the webpage's html files to build/html
python -m http.server build\html
Linux: python -m http.server build/html
Commit your changes with message that describe what you have done, e.g. added tutorial XY
or corrected typos
.
Push your changes to your
remote repository https://github.com/mygithubaccount/enmap-box-documentation-fork.git
Repeat the previous steps if you need to add further modifications
When done, publish your modifications in the official EnMAP-Box documentation creating a pull request.
./scripts/create_docs.sh
(windows/linux bash shell), or make html
, or (windows) make.bat html
.Substitute allow you to "recycle" code definitions
source/substitutions_manual.txt
. E.g. write .. |my_icon| image:: img/icons/myicon.png
`|my_icon|
in any *.rst file you like.python scripts/create_substitutes.py
to append the |my_icon|
to any *.rst file where it is usedmake.bat html
to build the documentation.