Pular para o conteúdo principal

Renderer.render_build

Página gerada do fonte

Gerada por tools/gerar_documentacao.py. Definição: tools/documentacao/render.py:1517.

Gera página viva de Makefile, workflows e comandos de build.

Tipo: função Python · Visibilidade: pública · Arquivo: tools/documentacao/render.py.

Assinatura e expansão​

def render_build(self) -> None:

Parâmetros formais: self.

Como funciona​

Gera página viva de Makefile, workflows e comandos de build.

Implementação completa · 48 linhas
def render_build(self) -> None:
"""Gera página viva de Makefile, workflows e comandos de build."""
self.category("guias", "Guias", 10)
body = ["# Build, comandos e integração contínua\n\n",
"## Makefile vivo\n\nTargets extraídos diretamente do Makefile:\n\n",
"| Target | Dependências | Linha |\n|---|---|---:|\n"]
for target in self.inv.make_targets:
body.append(f"| `{target['name']}` | `{target['dependencies'] or '—'}` | {self.gh_link('Makefile', target['line'], label=str(target['line']))} |\n")
body.append("\n## Workflows versionados\n\n")
for path in sorted((self.inv.root / ".github" / "workflows").glob("*.yml")):
relative = path.relative_to(self.inv.root).as_posix()
text = path.read_text(encoding="utf-8")
name = re.search(r"^name:\s*(.+)$", text, re.M)
label = name.group(1).strip() if name else path.stem
body.append(f"### {label}\n\n{self.gh_link(relative)}\n\n<details>\n<summary>Ver workflow</summary>\n\n")
body.append(fence(text, "yaml") + "\n</details>\n\n")
body.append("## Gerar este site\n\n```bash\npython3 -m venv .venv\n"
".venv/bin/python -m pip install -r tools/documentacao/requirements.txt\n"
"cd website\nnpm ci\nnpm run build\n```\n\n"
"No Windows, ative o ambiente com `.venv\\Scripts\\activate` e use `python` em vez de `.venv/bin/python`. "
"Veja [publicação e manutenção](/guias/publicacao) para GitHub Pages e evolução automática.\n")
body.append(self.faq(
"Perguntas frequentes sobre build local, alvos do Makefile e integração contínua.",
[
{"q": "Qual é o primeiro comando para construir tudo?",
"a": ["`make` produz o transpilador e a biblioteca em `build/`. O Makefile pressupõe "
"ambiente Unix-like; no Windows o projeto usa os workflows MSYS2/MinGW e MSVC "
"documentados no repositório."],
"code": "make\nls build/", "lang": "bash"},
{"q": "Quais alvos verificam a linguagem e a biblioteca?",
"a": ["Cada alvo cobre uma camada: casos dourados, suíte unitária, matriz de "
"portabilidade, sanitizers e fuzz de mutação do transpilador."],
"code": "make test\nmake test-biblioteca\nmake test-portabilidade\nmake test-sanitize\nmake fuzz",
"lang": "bash"},
{"q": "Como limpar artefatos sem apagar o fonte?",
"a": ["O alvo de limpeza remove a árvore `build/`; a lista completa de alvos está na "
"tabela acima, extraída do próprio Makefile."],
"code": "make limpar # confira o nome exato na tabela acima antes de usar", "lang": "bash"},
{"q": "O que a CI executa além dos testes locais?",
"a": ["A matriz de compiladores × padrões, sanitizers, cobertura, avaliação MSVC e o "
"workflow nativo MinGW-w64. A página de portabilidade explica quais estados "
"significam executado, compilado, avaliado e não testado."]},
{"q": "Este site é construído no mesmo pipeline?",
"a": ["Sim. `.github/workflows/docs.yml` instala Python e Node, gera o inventário, roda "
"os testes do gerador, compila o Docusaurus e publica via GitHub Pages."],
"code": "cd website\nnpm run build\nnpm run serve", "lang": "bash"},
]))
self.page("guias/build", "Build e CI", "".join(body))

Nomes internos referenciados: fence.

Como este símbolo aparece nos testes​

Sem uso direto localizado

Nenhuma referência direta a este nome foi encontrada nos arquivos de teste. Isso pode ser esperado para guardas de inclusão, configuração ou código exercitado indiretamente; não é uma afirmação de cobertura zero.

Compiladores, padrão C e sistema operacional​

Nenhum ramo condicional externo foi detectado para este símbolo. A implementação é compartilhada no fonte; isso não certifica compiladores ou sistemas não executados.

  • Script Python: usa a biblioteca padrão e pathlib/subprocess quando aplicável; caminhos não devem depender do separador de um único OS.
Não confunda implementação com certificação

A matriz histórica distingue executado, compilado, avaliado e não testado. Consulte a matriz, os compiladores e os logs atuais dos workflows antes de chamar um alvo de suportado.

Perguntas frequentes​

Perguntas reunidas a partir da definição, do contrato editorial e dos testes de Renderer.render_build. As respostas repetem apenas o que o repositório mostra; quando não há evidência, isso é dito.

Em uma frase, o que Renderer.render_build faz?​

Gera página viva de Makefile, workflows e comandos de build.

Qual é a assinatura e o tipo de retorno de Renderer.render_build?​

Assinatura extraída de tools/documentacao/render.py; visibilidade pública.

def render_build(self) -> None:

Como chamar Renderer.render_build corretamente?​

Nenhum exemplo editorial nem chamada direta em teste foi localizada. A forma de uso é a assinatura acima; os chamadores aparecem na seção de evidência indireta quando existem.

def render_build(self) -> None:

Por que não há teste direto para Renderer.render_build?​

A busca estática não encontrou o identificador nos arquivos de teste. Isso é esperado para guardas de inclusão, configuração de build e nomes alcançados apenas por chamadores internos. O JSON de cobertura registra a lacuna em vez de convertê-la em aprovação.

Renderer.render_build depende de compilador, padrão C ou sistema operacional?​

Renderer.render_build é uma função Python: requer Python 3.10+ e biblioteca padrão, sem compilador C.

O que acontece em caso de falha ou uso inválido?​

Não há ressalva editorial específica para este nome. O comportamento em falha é o do corpo/expansão mostrado acima; não invente validação que o fonte não faz.