Documentation Processing

[Gustry]

Some fixes to do:

• Hide None when there isn't a algorithm help string
• Add default values
• Update CSS for the table 3liz/3liz.github.io@e001db1
• For number, add min and max
• Use the new dedicated help string from QGIS 3.16
• For long help string, add some breaks or some fixed length for the cell (EG : check the OGR configuration https://docs.3liz.org/QuickOSM/processing/#parameters_5)
• Check min max if it match the Qt Limit, and 0
• For enums, take the list of values instead of the default value
• For FeatureSink and/or VectorLayer, check geometries
• For inputs and outputs, check if the list of not empty before adding the table. If empty, add a message : No output, No parameter
• Remove old PNG before regenerating them, we can find some leftover

[pdrillin]

@Gustry tous ça c'est que de la doc a faire ?

[Gustry]

Pas tout à fait. L'objectif du ticket, c'est de d'améliorer le script qui génère la documentation Processing. Il y a plusieurs petit soucis comme la liste à puce ci-dessus et aussi #10 . Ce n'est pas faire de la documentation directement.
Le script se trouve ici : https://github.com/3liz/qgis_plugin_tools/blob/master/infrastructure/doc_processing.py

Tu peux le lancer directement dans QGIS depuis la console par exemple.

[Gustry]

For Add default values and ** For number, add min and max**
Add a column Options and fill it with :

If there is a default value, add : Default : {}\n
If it's a Processing Number input : add tif it's float or integer and if min or max is defined, add them

ID	Description	Type	Info	Required	Advanced	Options
ADDRESS_LAYER	Voirie	VectorLayer		✓		Min : 0, Max : 10
STREET_LAYER	Point adresse	VectorLayer		✓		Type : DOuble

[Gustry]

About new line in a markdown table : https://stackoverflow.com/questions/11700487/newline-in-markdown-table

[pdrillin]

Pour: Hide None when there isn't a algorithm help string
il s'agit de modifier la partie en gras ci-dessous ?

markdown = TEMPLATE_ALGORITHM.format(
title=alg.displayName(),
help_string= alg.shortHelpString(),
parameters=param_markdown,
outputs=output_markdown,
img='./{}'.format(basename(output_screen)),
algo_id=alg.id(),
)

et mettre ça:
alg.shortHelpString() if alg.shortHelpString() else '', ?