Creation de la documentation

[pnavaro]

Salut Jeremy J'ai ajouté les premiers fichiers pour la doc. Il reste à entrer les clés pour générer le site. Je ne peux pas le faire car je ne suis pas propriétaire du dépôt. Voici les instructions

KidneyExchange.jl (master)$ julia
               _
   _       _ _(_)_     |  Documentation: https://docs.julialang.org
  (_)     | (_) (_)    |
   _ _   _| |_  __ _   |  Type "?" for help, "]?" for Pkg help.
  | | | | | | |/ _` |  |
  | | |_| | | | (_| |  |  Version 1.7.1 (2021-12-22)
 _/ |\__'_|_|_|\__'_|  |  Official https://julialang.org/ release
|__/                   |

(@v1.7) pkg> add DocumenterTools
    Updating registry at `~/.julia/registries/General.toml`
   Resolving package versions...
  No Changes to `~/.julia/environments/v1.7/Project.toml`
  No Changes to `~/.julia/environments/v1.7/Manifest.toml`

julia> using DocumenterTools

(@v1.7) pkg> activate .
  Activating project at `~/JuliaProjects/KidneyExchange.jl`

julia> using KidneyExchange
julia> DocumenterTools.genkeys(KidneyExchange)

Il te reste à suivre la procédure qui s'affiche en sortie de la dernière commande

A bientôt

PS: Il y a encore un souci avec le nom du package qui s'appelle toujours KEP par endroit, il faudrait remplacer par KidneyExchange

[jeremyomer]

Salut Pierre,

J'ai suivi les consignes. J'ai essayé de faire la suite en suivant une doc internet mais sans succès…

Merci pour ton aide !

Jérémy

Le 27 janv. 2022 à 16:12, Pierre Navaro @.***> a écrit :

Salut Jeremy J'ai ajouté les premiers fichiers pour la doc. Il reste à entrer les clés pour générer le site. Je ne peux pas le faire car je ne suis pas propriétaire du dépôt. Voici les instructions

KidneyExchange.jl (master)$ julia () | Documentation: https://docs.julialang.org () | () () | | |_ | Type "?" for help, "]?" for Pkg help. | | | | | | |/ ` | | | | || | | | (| | | Version 1.7.1 (2021-12-22) / |_'|||_'_| | Official https://julialang.org/ release |/ |

@.***) pkg> add DocumenterTools Updating registry at ~/.julia/registries/General.toml Resolving package versions... No Changes to ~/.julia/environments/v1.7/Project.toml No Changes to ~/.julia/environments/v1.7/Manifest.toml

julia> using DocumenterTools

@.***) pkg> activate . Activating project at ~/JuliaProjects/KidneyExchange.jl

julia> using KidneyExchange julia> DocumenterTools.genkeys(KidneyExchange) Il te reste à suivre la procédure qui s'affiche en sortie de la dernière commande

A bientôt

PS: Il y a encore un souci avec le nom du package qui s'appelle toujours KEP par endroit, il faudrait remplacer par KidneyExchange

— Reply to this email directly, view it on GitHub https://github.com/jeremyomer/KidneyExchange.jl/issues/1, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABDR6XZV33JGBMQU4WG3WITUYFOFTANCNFSM5M6F7ZSA. Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub. You are receiving this because you are subscribed to this thread.

[pnavaro]

Si ca marche ! https://jeremyomer.github.io/KidneyExchange.jl/dev/

[jeremyomer]

En effet, super ! Merci ! (j'étais allé voir trop vite après mon push on dirait)

Le 28 janv. 2022 à 12:41, Pierre Navaro @.***> a écrit :

Si ca marche ! https://jeremyomer.github.io/KidneyExchange.jl/dev/ https://jeremyomer.github.io/KidneyExchange.jl/dev/ — Reply to this email directly, view it on GitHub https://github.com/jeremyomer/KidneyExchange.jl/issues/1#issuecomment-1024135512, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABDR6X6XHQYRF2YS5X63UJDUYJ6HHANCNFSM5M6F7ZSA. Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub. You are receiving this because you commented.

[pnavaro]

Il y a beaucoup de citations dans la doc, je pense qu'on pourrait utiliser DocumenterCitations. Si tu as le fichier bibtex je peux ajouter ca.

[jeremyomer]

Oui, c'est une super idée ! Voici le fichier. Ca contient tous les articles sur le sujet, donc beaucoup plus que ce qui est cité dans le code. J'imagine que ça fait comme avec Latex et ça n'affiche dans les références que ce qui est cité, n'est-ce pas ?

Le 28 janv. 2022 à 13:04, Pierre Navaro @.***> a écrit :

Il y a beaucoup de citations dans la doc, je pense qu'on pourrait utiliser DocumenterCitations http://aliramadhan.me/DocumenterCitations.jl/dev/. Si tu as le fichier bibtex je peux ajouter ca.

— Reply to this email directly, view it on GitHub https://github.com/jeremyomer/KidneyExchange.jl/issues/1#issuecomment-1024150945, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABDR6X3SH6X3YMVBSRLJSH3UYKA4PANCNFSM5M6F7ZSA. Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub. You are receiving this because you commented.

[pnavaro]

Visiblement toutes les entrées du fichier bibtex sont listées dans les références. Je n'ai pas réussi à récupérer ton fichier alors j'ai fait un test avec quelques citations récupérées sur le web.

[pnavaro]

Salut Jeremy il faut recommencer la procédure en haut de cette issue, je ne comprends pas trop pourquoi mais c'est ce qui est conseillé

Please make sure you have the correct access rights
and the repository exists.
┌ Error: Git failed to fetch git@github.com:jeremyomer/KidneyExchange.jl
│ This can be caused by a DOCUMENTER_KEY variable that is not correctly set up.
│ Make sure that the environment variable is properly set up as a Base64-encoded string
│ of the SSH private key. You may need to re-generate the keys with DocumenterTools.

[jeremyomer]

Je pense avoir fait le nécessaire. Ce n'est pas la première fois que j'ai des problèmes avec Github ces derniers temps. Ils font des changements sans cesse, ce qui casse parfois des choses qui fonctionnaient très bien jusqu'ici. Est-ce qu'il y a une commande à lancer pour que la doc se mette à jour (en espérant que la manip ait fonctionné) ?

[pnavaro]

Récemment ils ont eu un problème de sécurité et il a fallu renouveler toutes les clés ssh.

[pnavaro]

Pour la doc c'est bon !

https://jeremyomer.github.io/KidneyExchange.jl/dev/

[jeremyomer]

Je viens de voir ça, merci !

Le 8 juin 2023 à 16:55, Pierre Navaro @.***> a écrit :

Pour la doc c'est bon !

https://jeremyomer.github.io/KidneyExchange.jl/dev/ https://jeremyomer.github.io/KidneyExchange.jl/dev/ — Reply to this email directly, view it on GitHub https://github.com/jeremyomer/KidneyExchange.jl/issues/1#issuecomment-1582741410, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABDR6X2N4E7HTVGJ3S674GDXKHRULANCNFSM5M6F7ZSA. You are receiving this because you commented.

[pnavaro]

Je ferme le ticket, ca marche, désolé pour les tonnes d'emails qui a du recevoir. Bonne soirée!

[jeremyomer]

Vue la vitesse à laquelle tu m'as aidé, je vais quand-même pas me plaindre pour une petite dizaine d'emails qui sont allés direct à la poubelle. Encore merci à toi !

Le 8 juin 2023 à 17:29, Pierre Navaro @.***> a écrit :

Je ferme le ticket, ca marche, désolé pour les tonnes d'emails qui a du recevoir. Bonne soirée!

— Reply to this email directly, view it on GitHub https://github.com/jeremyomer/KidneyExchange.jl/issues/1#issuecomment-1582826315, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABDR6XZ3FRMXNJLHMLYVUJ3XKHVUVANCNFSM5M6F7ZSA. You are receiving this because you commented.