rebar3 générer edoc pour plusieurs applications

Question

Si j'ai une mise en page du Bureau du Procureur comme ceci:

foo/ 
    - apps/ 
    - bar1/ 
     - src/ 
    - bar2 
     - src/ 

Comment puis-je générer edoc pour les deuxbar1 et bar2?

Si je cours:

rebar3 edoc 

ce que je reçois est des fichiers .html séparés dans bar1/doc et bar2/doc, et aucun des liens entre eux travaillent (à savoir les types d'exportation ne sont pas correctement liés).

Merci.

Answer 1

A écrit un plugin rebar3 appelé medoc, qui fera en sorte docs générés par edoc sont correctement liés et table des matières est mis à jour:

https://github.com/drozzy/medoc

Exécuter en tant:

rebar3 medoc 

En ce qui concerne la norme edoc, cela ne semble pas encore être une fonctionnalité. Une solution intermédiaire consiste à utiliser dans votre config barres d'armature:

{edoc_opts, [{dir, "doc"}]} 

Mais ce ne sera pas à jour la table des matières correctement (à savoir que vous ne verrez que le toc d'une application).

Answer 2

Ceci n'est actuellement pas supporté par Rebar3.

Vous pouvez voir in the source code que la commande edoc effectue simplement la boucle sur chaque application sans aucun état maintenu entre eux. Je ne suis pas sûr de ce qu'il faudrait faire pour les connecter, mais ouvrir un problème sur le référentiel Rebar3 pour en discuter est probablement la meilleure façon de commencer.