Commit 945f399
committed
DOCS: reformula README e documentação com galeria de PDFs de exemplo
Revisão completa do README e do site de documentação (en + pt):
- Galeria de miniaturas PNG dos cinco documentos gerados (README com
URLs absolutas para renderizar no PyPI; home da doc com coluna de
prévia) e imagem de exemplo no topo de cada página de documento.
Miniaturas geradas por scripts/generate_screenshots.py a partir das
fixtures de teste (reproduzível; documentado no guia de contribuição).
- DANFSE incluído onde estava invisível: tabela da home, abas de
instalação e quick start do getting-started, comandos do CLI e
snippet do README; criado docs/danfse.pt.md (única página sem
tradução) e a página foi expandida com leiaute aceito (Padrão
Nacional), extra de instalação, font_type, decimal_config e marcas
d'água.
- Correções factuais apontadas por auditoria contra o código: licença
é LGPL-3.0 (e não AGPL, como o classifier do pyproject sugere);
precedência e variantes das marcas d'água (CANCELADA / CANCELADA -
SEM VALOR FISCAL / SEM VALOR FISCAL automática) em DANFE, DACTE e
DANFSE; comportamentos automáticos do DAMDFE (homologação e
contingência com prazo de 168h); faixas de margem suportadas pelo
DAMDFE; qrcode também é exigido pelo DANFSE; nota de aplicabilidade
do config.yaml do CLI por comando (ISSUER/LOGO/margens) e nome do
arquivo de saída.
- Opções mortas sinalizadas com aviso em vez de documentadas como
funcionais: receipt_pos e decimal_config no DACTE, decimal_config no
DAMDFE, quantity_precision no DANFSE; tax_configuration removido do
exemplo do DANFE (aviso já existia).
- Paridade en/pt restaurada: seções Footer Stamp e quebra de linha do
infCpl traduzidas no danfe.pt.md; demais páginas espelhadas 1:1.
- README com seção de diferenciais, badges de versões de Python e
Streamlit, link para a doc em português, faixa de Python suportada,
CTA da demo online e seção de licença; páginas About enriquecidas.
- Guia de contribuição: extra danfse no install editável, ativação de
venv no Windows, qpdf recomendado (fallback por hash), hook
no-generate-true, seção de como trabalhar na documentação (MkDocs +
i18n por sufixo) e regeneração das miniaturas.
Exemplos de código executados contra as fixtures (15/15 ok), site
construído com mkdocs --strict e links internos das builds en/pt
verificados.1 parent 2e5bf37 commit 945f399
27 files changed
Lines changed: 817 additions & 171 deletions
File tree
- docs
- assets/screenshots
- scripts
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| 8 | + | |
8 | 9 | | |
9 | 10 | | |
10 | 11 | | |
11 | | - | |
| 12 | + | |
12 | 13 | | |
13 | 14 | | |
14 | 15 | | |
15 | | - | |
| 16 | + | |
16 | 17 | | |
17 | 18 | | |
18 | 19 | | |
19 | | - | |
| 20 | + | |
20 | 21 | | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
28 | 34 | | |
29 | 35 | | |
30 | 36 | | |
| |||
59 | 65 | | |
60 | 66 | | |
61 | 67 | | |
| 68 | + | |
62 | 69 | | |
63 | 70 | | |
64 | 71 | | |
| |||
67 | 74 | | |
68 | 75 | | |
69 | 76 | | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
70 | 81 | | |
71 | 82 | | |
72 | 83 | | |
73 | 84 | | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
74 | 89 | | |
75 | 90 | | |
76 | 91 | | |
| |||
92 | 107 | | |
93 | 108 | | |
94 | 109 | | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
95 | 114 | | |
96 | 115 | | |
97 | 116 | | |
98 | 117 | | |
99 | 118 | | |
100 | 119 | | |
| 120 | + | |
| 121 | + | |
101 | 122 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
3 | 6 | | |
4 | 7 | | |
5 | 8 | | |
6 | 9 | | |
7 | | - | |
| 10 | + | |
8 | 11 | | |
9 | 12 | | |
| 13 | + | |
| 14 | + | |
10 | 15 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
3 | 6 | | |
4 | 7 | | |
5 | 8 | | |
6 | 9 | | |
7 | | - | |
| 10 | + | |
8 | 11 | | |
9 | 12 | | |
| 13 | + | |
| 14 | + | |
10 | 15 | | |
Loading
Loading
Loading
Loading
Loading
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
2 | | - | |
3 | | - | |
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | 7 | | |
| |||
20 | 21 | | |
21 | 22 | | |
22 | 23 | | |
23 | | - | |
| 24 | + | |
24 | 25 | | |
25 | 26 | | |
26 | 27 | | |
27 | 28 | | |
28 | 29 | | |
29 | | - | |
| 30 | + | |
30 | 31 | | |
31 | 32 | | |
32 | 33 | | |
33 | 34 | | |
34 | 35 | | |
35 | | - | |
| 36 | + | |
36 | 37 | | |
37 | 38 | | |
38 | 39 | | |
39 | 40 | | |
40 | 41 | | |
41 | | - | |
| 42 | + | |
42 | 43 | | |
43 | 44 | | |
44 | 45 | | |
45 | 46 | | |
46 | 47 | | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
47 | 54 | | |
48 | 55 | | |
49 | 56 | | |
| |||
67 | 74 | | |
68 | 75 | | |
69 | 76 | | |
70 | | - | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
2 | | - | |
3 | | - | |
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | 7 | | |
| |||
20 | 21 | | |
21 | 22 | | |
22 | 23 | | |
23 | | - | |
| 24 | + | |
24 | 25 | | |
25 | 26 | | |
26 | 27 | | |
27 | 28 | | |
28 | 29 | | |
29 | | - | |
| 30 | + | |
30 | 31 | | |
31 | 32 | | |
32 | 33 | | |
33 | 34 | | |
34 | 35 | | |
35 | | - | |
| 36 | + | |
36 | 37 | | |
37 | 38 | | |
38 | 39 | | |
39 | 40 | | |
40 | 41 | | |
41 | | - | |
| 42 | + | |
42 | 43 | | |
43 | 44 | | |
44 | 45 | | |
45 | 46 | | |
46 | 47 | | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
47 | 54 | | |
48 | 55 | | |
49 | 56 | | |
| |||
67 | 74 | | |
68 | 75 | | |
69 | 76 | | |
70 | | - | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
0 commit comments