pythonbrasil / pythonbrasil/wiki
Disponibilizar documentação do Python em PDF
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 178
- Forks
- 168
- Avg merge
- 30m
- Merged PRs (30d)
- 2
Description
As pessoas no núcleo do desenvolvimento do Python decidiram não fornecer mais a documentação em formato PDF.
Sugiro que façamos isso. Penso que para o Brasil isso é bem relevante, e podemos fazer algo até melhor.
A ideia inicial é criar um novo item no menu Inicie-se: Documentação.
Nele, vai ter o link para a documentação oficial on-line, mas também serão listados os PDFs para download. Atualmente, isso é disponibilizado no docs.python.org em um zip com mais de 30 arquivos PDF dentro. Acredito que listar diretamente os arquivos PDF seja mais prático, pois a pessoa pode abrir diretamente no navegador.
Penso que seja interessante um arquivo por seção da documentação:
- Tutorial
- Referencia da biblioteca
- Referencia da linguagem
- Configurações e uso do Python
- Guias de como fazer (Python HOWTOS)
- ...
- FAQs
- ....
Howtos atualmente são arquivos separados, acredito que possa ser um único arquivo com todos eles.
Além de um com a "Documentação Completa".
Foi aberta uma issue para que essa geração dos PDFs seja feita no ambito da tradução da documentação
cc @rffontenelle
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how the "Inicie-se" menu is defined in the Python Brasil wiki and inspect issue #271 about generating the translated PDFs. The work is complete when the new Documentation item links to the official online documentation and lists downloadable PDFs by section, including a complete documentation PDF.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100