Commit 8f90c314 authored by Timm Schoening's avatar Timm Schoening
Browse files

added mkdocs documentation

parent 79e2f6dc
Pipeline #73293 failed with stage
in 50 seconds
# MarIQT core
::: mariqt.core
# MarIQT directories
::: mariqt.directories
# MarIQT dship
::: mariqt.sources.dship
# MarIQT dship_settings
::: mariqt.sources.dship_settings
# MarIQT equipment
::: mariqt.equipment
# MarIQT files
::: mariqt.files
# MarIQT geo
::: mariqt.geo
# MarIQT image
::: mariqt.image
# Welcome to MkDocs
> **Preamble:** We strive to make marine image data [FAIR](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/fair-marine-images/-/blob/master/docs/FAIR-marine-images.md). We develop [FDOs](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/fair-marine-images/-/blob/master/docs/ifdos/iFDO-overview.md) for images to establish a common language for marine imagery, we develop best-practice [operating procedures](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/fair-marine-images/-/blob/master/docs/sops/sop-overview.md) for handling marine images and - here in this repository - we develop [software tools](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/mariqt) to apply the vocabulary and procedures to marine imagery.
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
# MarIQT
## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
Image Quality control / quality assurance and curation Tools (IQT) conceptualised and developed by the MareHub working group on Videos/Images (part of the DataHub, a research data manangement initiative by the Helmholtz association). The MarIQT core is a [python package](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/mariqt) which is helpful on its own but is key to the more user-friendly [jupyter notebooks](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/mariqt-notebooks) that make extensive use of the python package.
# MarIQT navigation
::: mariqt.navigation
# MarIQT ofop
::: mariqt.sources.ofop
# MarIQT provenance
::: mariqt.provenance
# MarIQT reports
::: mariqt.reports
# MarIQT settings
::: mariqt.settings
# MarIQT svgs
::: mariqt.sources.svgs
# MarIQT tests
::: mariqt.tests
# MarIQT variables
::: mariqt.variables
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
pytestdebug.log
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
doc/_build/
# PyBuilder
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
.python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# poetry
#poetry.lock
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
# .env
.env/
.venv/
env/
venv/
ENV/
env.bak/
venv.bak/
pythonenv*
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# operating system-related files
# file properties cache/storage on macOS
*.DS_Store
# thumbnail cache on Windows
Thumbs.db
# profiling data
.prof
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment