DOCS: revamp do README e da documentação + fix DaCCe sem emitente#180
Merged
antoniospneto merged 16 commits intoJun 13, 2026
Conversation
O exemplo de uso básico da documentação (DaCCe(xml=...)) quebrava porque emitente_nome só era atribuído dentro de "if emitente:". Inicializa o nome vazio e adiciona teste de regressão sem emitente.
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.
…pendencies/Credits, casing dos badges
…as em inglês e snippet auto-contido
…cumentos, CC-e citada à parte
# Conflicts: # docs/danfse.md
…por engano via git add -A)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resumo
Revamp completo do README e da documentação, com galeria de PDFs de exemplo, mais um bugfix do DaCCe que estava pendente.
README / documentação
NF-e → DANFE,CT-e → DACTE, …).DanfeConfig, auto-contido).[cli], exemplo herói com o output e oconfig.yaml.pyproject.toml) e de Credits (a atribuição ao autor original segue preservada nos headers de copyright do código e na página About).Engenerepadronizado.main).scripts/generate_screenshots.py— gera as miniaturas a partir das fixtures de teste.Fix
UnboundLocalErrorquandoemitentenão é informado (+ testetest_dacce_without_emitente).