Skip to content
Snippets Groups Projects
Commit 2eb6ae0e authored by Yoann Schneider's avatar Yoann Schneider :tennis:
Browse files

MDformat setup

parent 52ec0176
No related branches found
No related tags found
1 merge request!60MDformat setup
Pipeline #74944 passed
......@@ -92,12 +92,34 @@ pages:
only:
- master
- dev-v2
- tags
except:
- schedules
docs-deploy:
image: node:18
stage: release
dependencies:
- docs-build
before_script:
- npm install -g surge
except:
- master
- tags
- schedules
environment:
name: ${CI_COMMIT_REF_SLUG}
url: https://${CI_COMMIT_REF_SLUG}-atr-data-generator.surge.sh
on_stop: docs-stop-surge
script:
- surge public ${CI_ENVIRONMENT_URL}
docs-stop-surge:
image: node:18
stage: release
......@@ -109,7 +131,6 @@ docs-stop-surge:
except:
- master
- dev-v2
- tags
- schedules
......
......@@ -14,6 +14,13 @@ repos:
additional_dependencies:
- 'flake8-coding==1.3.2'
- 'flake8-debugger==4.1.2'
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.16
hooks:
- id: mdformat
# Optionally add plugins
additional_dependencies:
- mdformat-mkdocs[recommended]
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
hooks:
......
......@@ -6,16 +6,18 @@ It also generates reproducible train, val and test splits.
A documentation is available at https://teklia.gitlab.io/atr/data-generator/.
## Environment variables
`ARKINDEX_API_TOKEN` and `ARKINDEX_API_URL` environment variables must be defined.
You can create an alias by adding this line to your `~/.bashrc`:
```sh
alias set_demo='export ARKINDEX_API_URL=https://demo.arkindex.org/;export ARKINDEX_API_TOKEN=my_api_token'
```
Then run:
```sh
source ~/.bashrc
set_demo
......
......@@ -2,10 +2,10 @@
## Base setup
* Use a virtualenv (e.g. with virtualenvwrapper `mkvirtualenv -a . atr-data-gen`)
* Install atr-data-generator as a package
* The `teklia-document-processing` library is setup via git submodule. Please run `git submodule update --init`.
* Then install both packages via `pip install ./document-processing -e .`
- Use a virtualenv (e.g. with virtualenvwrapper `mkvirtualenv -a . atr-data-gen`)
- Install atr-data-generator as a package
- The `teklia-document-processing` library is setup via git submodule. Please run `git submodule update --init`.
- Then install both packages via `pip install ./document-processing -e .`
## Unit tests
......@@ -19,6 +19,7 @@ Tests are executed with [tox](https://tox.wiki/), based on [pytest](https://docs
The documentation is generated via [mkdocs](https://mkdocs.readthedocs.io/) and [mkdocstrings](mkdocstrings.github.io/). Please keep it updated when modifying or adding features.
It's pretty easy to do:
```console
pip install -e .[docs]
mkdocs serve
......
# Arguments
::: atr_data_generator.extract.arguments
\ No newline at end of file
::: atr_data_generator.extract.arguments
# Arguments
::: atr_data_generator.split.arguments
\ No newline at end of file
::: atr_data_generator.split.arguments
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment