Comments (3)
É 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
#41.
from astran.
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.
from astran.
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.
from astran.
Related Issues (20)
- Image issues HOT 12
- Missing astran.cfg HOT 8
- Astran version information HOT 4
- Astran commands HOT 7
- Tech rule improvement HOT 2
- Status da finalização do Astran HOT 3
- Text Labels in GDSII HOT 2
- Dependências gráficas rodando pelo shell HOT 3
- Arquivo history.log HOT 2
- Nome dos devices HOT 1
- Compilando o wxSightGL HOT 1
- Unable to generate cells due to lp_solve error HOT 4
- Technology rule file for Astran HOT 2
- Missing Layout Image HOT 1
- lpsolve support HOT 1
- What LICENSE is this code under? HOT 2
- Consider supporting SKY130? HOT 1
- Gurobi 9.5 support? HOT 2
- Cellgen compact error: can't solve ILP and M5 gate length smaller than tech HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from astran.