search

GeotrekCE / Geotrek-rando-v3

Geotrek public data website (version 3)
https://geotrek.fr/produit.html#rando
MIT License
16 stars 16 forks source link

Publish docs on readthedocs #1254

Open camillemonchicourt opened 1 week ago

bruhnild commented 4 hours ago

Changements visibles ici : https://geotrek-rando-v3.readthedocs.io/latest/

camillemonchicourt commented 4 hours ago

OK pour moi (hormis le copyright), ça rend bien comme ça.

camillemonchicourt commented 3 hours ago

Par contre, j'avais identifié quelques soucis avec mkdocs. Les code blocks ne peuvent pas être indenté comme mentionné ici : https://www.mkdocs.org/user-guide/writing-your-docs/#fenced-code-blocks

Exemple ici de code bloc indenté : image

Non indenté est OK : image

La seule bonne solution pour cela semble être l'ajout de l'extension https://facelessuser.github.io/pymdown-extensions/extensions/superfences/, comme discuté ici : https://github.com/mkdocs/mkdocs/issues/282#issuecomment-393717991

Et les notes, warning and co qui ne sont pas interprétés : image Alors que c'est le cas sur Github : image

Je ne les ai peut-être pas renseignés comme il faut. Je creuse un peu ça.

Après si mkdocs c'est pas idéal, j'ai pas de préférence d'outil. Mais l'important est que ça soit simple à mettre en place, déployer et maintenir (installer le moins d'outils et d'extensions) pour que ça soit stable dans le temps, simple de contribuer (markdown idéal), et le plus homogène possible entre Geotrek-admin et Geotrek-rando en terme de présentation et d'affichage.

bruhnild commented 23 minutes ago

J'ai réindenté les bouts de code et l'affichage est beaucoup mieux.

image

camillemonchicourt commented 20 minutes ago

J'ai réindenté les bouts de code et l'affichage est beaucoup mieux.

image

Oui, du coup ce n'est plus forcément bien aligné quand c'est dans une liste ou un sous-ensemble, mais il vaut mieux en effet.

bruhnild commented 15 minutes ago

Ok pour merger ?