Referência da API

A interface pública, agrupada pela divisão de topo do próprio código: opendata_cvm.ingestion (leitura ← CVM). O envio vive no pacote separado layouts-cvm.

Veja também: Uso · Exemplos

Páginas

Grupo	Conteúdo
Referência	Cada símbolo público: leitores (ingestion, por raiz do portal)

Crescendo esta seção

Esta seção é um diretório, e não uma página única, de propósito. A referência da API cresce a cada unidade publicada; uma api.md única vira a maior página do repositório, e dividi-la depois apodrece todo link profundo já publicado — para sempre, quando a documentação versionada (mike) está no ar, pois /<versão>/api/#âncora existe eternamente.

Ao adicionar páginas:

• Agrupe pela divisão de topo do próprio código — nunca invente uma taxonomia paralela. Quem conhece o pacote adivinha a URL, e a documentação não se afasta da estrutura que espelha.
• A profundidade segue a contagem, não o gosto. O eixo real escolhe as seções; só o volume decide se uma seção precisa de um segundo nível.
• A prosa compartilhada por um grupo vive uma vez, na página do grupo.
• Registre toda página nova no nav: do mkdocs.yml no mesmo commit. O MkDocs publica a página mesmo sem registro — ela só some da navegação, e é isso que o gate bin/check_docs_sections.py existe para pegar.
• A entrada de cada novo leitor entra em reference.md (ou em uma página irmã neste diretório) — nunca em um docs/api.md, que não existe mais.