Documentação

[leoheck]

Adriel, tu já conhece o Read The Docs? É uma plataforma pra fazer documentações. O astran podia ter uma documentação lá. Toda documentação é gerada por arquivos texto como os README.md do github. Ele tem integraçào com o github tb e faz tuido automático. O bacana é que cada página é um arquivo texto com alguma tags simples. No fim, ele gera uma documentação reobusta, organizada e com um sistema de busca que facilita muito. Aqui tem um exemplo do da documentação do sublime text http://docs.sublimetext.info/en/latest/index.html. Acho interessante tu pensar nesse tipo de coisa. Que tu acha?

[aziesemer]

É uma coisa que está fazendo falta no Astran mas que eu nunca dei prioridade pois era só eu quem desenvolvia (e usava) basicamente. Mas vou dar uma olhada...

2015-10-09 13:31 GMT-03:00 Leandro Heck [email protected]:

Adriel, tu já conhece o https://readthedocs.org/? É uma plataforma pra fazer documentações. O astran podia ter uma documentação lá. Toda documentaçÃo é gerada por arquivos texto como os README.md do github. Ele tem integraçào com o github tb e faz tuido automático. O bacana é que cada página é um arquivo texto com alguma tags simples. No fim, ele gera uma documentação reobusta, organizada e com um sistema de busca que facilita muito. Aqui tem um exemplo do da documentação do sublime text http://docs.sublimetext.info/en/latest/index.html. Acho interessante tu pensar nesse tipo de coisa. Que tu acha?

— Reply to this email directly or view it on GitHub https://github.com/aziesemer/astran/issues/41.

[leoheck]

Pois é isso está faltando mesmo. Existem comandos que eu gostaria de saber melhor o que fazem. Por exemplo, o comando cellgen compact faz o que exatamente? Eu poderia combinar contigo de eu criar o inicio da documentação no Read The Docs como eu te falei, para te mostrar como funcionaria. Alpem disso posso te explicar como usar. E tu, em contrapartida poderia ir adicionando informação sobre os comandos Astran, iniciando pelos mais importantes. Que tu acha da ideia?

O Read The Docs, pode ser adicionado no github, inclusive acho que da pra criar uma pastinha aqui mesmo neste repositorio. O site deles é responsavel por atualizar o site quando tiver dados novos no github, além de site, eles tb exportam em .pdf e outros formatos (se não me engano).

Se/Quando tu topar, me avisa que já inicio o projeto.

[leoheck]

Eu iniciei uma documentação dentro do meu fork pra ti mostrar como é massa. Lá tem um diretório astra/Astran/docs/ que contém a documentação. Depois, configurei o Read The Docs (RTD) pra sincornizar com o projeto. Quando a pasta docs é atualizada o RTD gera uma versao nova da documentação que ele hospeda. Aqui tem um link de exemplo do que eu gerei pra testes: https://astran.readthedocs.org/en/latest/commands.html#export . Não tá mto organizado, eu só colei uns arquivos e textos la dentro.