Python · tools/documentacao/render
Fonte: tools/documentacao/render.
| Função | Linhas | Resumo | Referências diretas |
|---|---|---|---|
fence | 41–45 | Cria code fence MDX seguro para código que contenha crases. | 0 |
protect | 48–58 | Escapa sintaxe MDX acidental em prosa, sem tocar em código Markdown. | 2 |
quote | 61–63 | Transforma comentário em blockquote Markdown seguro para MDX. | 0 |
plain | 66–68 | Reduz texto Markdown a uma descrição curta para metadados. | 0 |
code_language | 71–74 | Mapeia extensão de arquivo para linguagem de realce Prism. | 0 |
Renderer.__init__ | 78–93 | Inicializa índices de referências, símbolos e auditoria do renderizador. | 0 |
Renderer.macro_target | 95–101 | Resolve apelido curto para a macro canônica definida no cabeçalho público. | 0 |
Renderer.macro_category | 103–128 | Classifica macro por família semântica para navegação e índice. | 0 |
Renderer.slug | 130–144 | Gera rota estável por tipo/módulo, reunindo apelidos de macro. | 0 |
Renderer.link | 146–148 | Cria link Markdown para a página de um símbolo. | 0 |
Renderer.gh | 150–153 | Monta permalink GitHub para arquivo e linha no commit do build. | 0 |
Renderer.gh_link | 155–157 | Cria link Markdown para fonte/linha no GitHub. | 0 |
Renderer.page | 159–169 | Registra página MDX com frontmatter determinístico e metadados. | 0 |
Renderer.category | 171–174 | Registra categoria de sidebar Docusaurus. | 0 |
Renderer.contract | 176–201 | Resolve contrato editorial por nome, padrão, apelido ou função relacionada. | 0 |
Renderer.names_for | 203–205 | Retorna nome canônico e apelidos usados na busca de evidências. | 0 |
Renderer.direct_refs | 207–217 | Reúne referências diretas do símbolo e de seus apelidos sem duplicatas. | 0 |
Renderer.source_snippet | 219–227 | Recorta linhas de contexto e resolve fonte real de heredoc virtual. | 0 |
Renderer.faq | 229–243 | Monta a seção de perguntas frequentes de uma página. Cada item traz uma pergunta, parágrafos de resposta e, opcionalmente, um trecho de código real (fonte, test | 0 |
Renderer.external_conditions | 245–248 | Condições reais de plataforma, sem a guarda de inclusão do cabeçalho. | 0 |
Renderer.usage_snippet | 250–260 | Recorta o primeiro uso real do símbolo nos testes, com linguagem e linha. | 0 |
Renderer.symbol_recipe | 262–277 | Comando real de build/teste para exercitar o símbolo na stack do projeto. | 0 |
Renderer.integration_checklist | 279–313 | Checklist de integração derivado do tipo, do módulo e dos guards do símbolo. | 0 |
Renderer.symbol_faq | 315–439 | Perguntas frequentes específicas de uma página de símbolo. | 0 |
Renderer.category_faq | 441–480 | FAQ de uma família de macros, montado com nomes e expansões reais. | 0 |
Renderer.module_faq | 482–517 | FAQ de um módulo da biblioteca, com receita de build e contrato de retorno. | 0 |
Renderer.render_refs | 519–560 | Renderiza arquivos, linhas, contextos e trechos de uso em testes. | 0 |
Renderer.indirect_refs | 562–578 | Mostra chamadores e testes deles como evidência indireta explícita. | 0 |
Renderer.modes_for | 580–595 | Calcula quais modos do harness alcançam o símbolo pelo grafo de chamadas. | 0 |
Renderer.runner_mode_lines | 597–604 | Localiza invocações literais de um modo no runner da biblioteca. | 0 |
Renderer.render_modes | 606–619 | Renderiza modos de integração/falha fatal ligados ao símbolo. | 0 |
Renderer.nearby_directives | 621–629 | Diretivas vizinhas que afetam atributos/diagnósticos, não só o corpo. | 0 |
Renderer.portability | 631–682 | Renderiza guards, diretivas, marcadores e ressalvas de compilador/OS. | 0 |
Renderer.render_symbol | 684–794 | Monta a página completa de um símbolo com contrato, fonte, testes e portabilidade. | 0 |
Renderer.render_indexes | 796–935 | Gera índices de referência por família de macro e módulo de biblioteca. | 0 |
Renderer.render_tests | 937–1053 | Gera índice de suítes, casos, harness e modos de integração. | 0 |
Renderer.suite_faq | 1055–1091 | FAQ de uma suíte de casos dourados, com contagens e modos reais. | 0 |
Renderer.case_faq | 1093–1133 | FAQ de um caso dourado: execução, arquivos e resultado esperado. | 0 |
Renderer.mode_faq | 1135–1161 | FAQ de um modo de integração/falha fatal do harness. | 0 |
Renderer.render_case | 1163–1196 | Renderiza um caso dourado/negativo/aviso com todos os seus arquivos. | 0 |
Renderer.render_harness | 1198–1233 | Lista funções C de teste e scripts runners com links de fonte. | 0 |
Renderer.internal_faq | 1235–1262 | FAQ de um arquivo interno (transpilador, harness, runner ou script). | 0 |
Renderer.example_faq | 1264–1293 | FAQ de um exemplo executável, com compilação e resultado esperado. | 0 |
Renderer.render_internals | 1295–1339 | Agrupa funções internas por linguagem e arquivo. | 0 |
Renderer.render_examples | 1341–1375 | Publica exemplos versionados e suas saídas douradas. | 0 |
Renderer.related_symbols | 1377–1392 | Símbolos públicos realmente citados no texto, em ordem de ocorrência. | 0 |
Renderer.document_extra | 1394–1412 | Acrescenta a um documento importado os símbolos citados e o FAQ editorial. | 0 |
Renderer.import_markdown | 1414–1426 | Importa documento original ajustando título, links e sintaxe MDX. | 0 |
Renderer.rewrite_links | 1428–1451 | Reescreve links relativos para páginas importadas ou permalinks GitHub. | 0 |
Renderer.rewrite_links.replace | 1436–1450 | Resolve um link Markdown individual contra o mapa de documentos/fontes. | 0 |
Renderer.escape_mdx | 1453–1472 | Escapa prosa linha a linha sem modificar blocos de código fenced. | 0 |
Renderer.render_project | 1474–1515 | Importa especificação, decisões, relatórios, README e cobertura versionada. | 0 |
Renderer.render_build | 1517–1564 | Gera página viva de Makefile, workflows e comandos de build. | 0 |
Renderer.write | 1566–1618 | Renderiza todas as páginas, guias e JSONs e escreve a árvore gerenciada. | 0 |
Perguntas frequentes
Perguntas frequentes sobre tools/documentacao/render e as 54 função(ões) indexada(s) nele.
Que funções este arquivo expõe?
As funções abaixo foram extraídas do próprio arquivo. Elas são internas ao projeto: não fazem parte da API pública de basicgol.h.
def fence(text: str, language: str = "text") -> str:
def protect(text: str) -> str:
def quote(text: str) -> str:
def plain(text: str) -> str:
def code_language(path: str) -> str:
def __init__(self, inv: Inventory, contracts: dict, repo_url: str, commit: str):
Como executar este arquivo?
Depende do tipo de arquivo. A receita abaixo é a do projeto; flags e argumentos específicos estão na assinatura de cada função.
python3 tools/documentacao/render
As funções internas têm teste próprio?
1 das 54 funções possuem referência direta nos testes. As demais podem ser alcançadas apenas por chamadores; o JSON de cobertura registra a lacuna.
Qual é o contrato de fence?
Cria code fence MDX seguro para código que contenha crases.
def fence(text: str, language: str = "text") -> str:
"""Cria code fence MDX seguro para código que contenha crases."""
runs = re.findall(r"`+", text)
ticks = "`" * max(3, max((len(r) + 1 for r in runs), default=3))
return f"{ticks}{language}\n{text.rstrip()}\n{ticks}\n"