diff --git a/docs/docs/en/api_reference_python.md b/docs/docs/en/api_reference_python.md index ee1706e51..b2638026e 100644 --- a/docs/docs/en/api_reference_python.md +++ b/docs/docs/en/api_reference_python.md @@ -6,3 +6,59 @@ This API is composed of functions with two types of functionality: - Modules for **data request**: for those who only want to consult the data and metadata of our project. - Classes for **data management** in Google Cloud: for those who want to upload data to our project (or any other project in Google Cloud, following our methodology and infrastructure). + +## Modules (Data requests) + +::: basedosdados.download.metadata + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no + +::: basedosdados.download.download + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no + +## Classes (Data management) + +::: basedosdados.upload.storage + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no + +--- +::: basedosdados.upload.dataset + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no + +--- +::: basedosdados.upload.table + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no \ No newline at end of file diff --git a/docs/docs/es/api_reference_python.md b/docs/docs/es/api_reference_python.md index 70923bac4..481f103f1 100644 --- a/docs/docs/es/api_reference_python.md +++ b/docs/docs/es/api_reference_python.md @@ -10,3 +10,59 @@ Esta API está compuesta por funciones con 2 tipos de funcionalidad: proyecto en Google Cloud, siguiendo nuestra metodología e infraestructura). !!! Info "Toda la documentación del código siguiente está en inglés" + +## Módulos (Solicitud de datos) + +::: basedosdados.download.metadata + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no + +::: basedosdados.download.download + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no + +## Clases (Gestión de datos) + +::: basedosdados.upload.storage + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no + +--- +::: basedosdados.upload.dataset + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no + +--- +::: basedosdados.upload.table + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no \ No newline at end of file diff --git a/docs/docs/pt/api_reference_python.md b/docs/docs/pt/api_reference_python.md index 16df18bdb..60c6df390 100644 --- a/docs/docs/pt/api_reference_python.md +++ b/docs/docs/pt/api_reference_python.md @@ -11,3 +11,59 @@ Esta API é composta por funções com 2 tipos de funcionalidade: projeto no Google Cloud, seguindo a nossa metodologia e infraestrutura). !!! Info "Toda documentação do código abaixo está em inglês" + +## Módulos (Requisição de dados) + +::: basedosdados.download.metadata + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no + +::: basedosdados.download.download + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no + +## Classes (Gerenciamento de dados) + +::: basedosdados.upload.storage + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no + +--- +::: basedosdados.upload.dataset + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no + +--- +::: basedosdados.upload.table + handler: python + rendering: + show_root_heading: no + heading_level: 3 + selection: + docstring_style: google # this is the default + docstring_options: + replace_admonitions: no \ No newline at end of file