Merge pull request #11 from ThiagoPanini/v0.1.x

Nova versão da documentação no readthedocs

docs/contribuindo/contribuindo.md

@@ -0,0 +1,29 @@
+# Contribuindo com o pynvest
+
+Curtiu o projeto e encontrou alguma oportunidade de contribuir com ele de alguma forma? Vai fundo! Sendo uma iniciativa *open source*, qualquer um interessado em deixar sua contribuição será extremamente bem vindo.
+
+???+ question "Para contribuir eu preciso necessariamente escrever linhas de código?"
+    Não necessariamente! Uma contribuição pode ser desde um módulo adicional na biblioteca, como também o apontamento de alguma *issue* ou *feature request*. Sua interação é extremamente válida para manter a ideia viva!
+
+
+O pacote surgiu de forma despretensiosa e com o simples objetivo de facilitar a gestão financeira pessoal do criador. Ao longo do tempo, percebeu-se que tais funcionalidades poderiam facilmnente ajudar outras pessoas dentro do mesmo escopo e propósito. Assim, a biblioteca tomou forma e, hoje, o resultado atual se mostra dentro de tudo o que está consolidado nesta documentação.
+
+
+## Como Contribuir?
+
+Bom, em primeiro lugar, é importante que os potenciais contribuidores tenham a ciência completa sobre a biblioteca *pynvest* e o seu propósito. Dessa forma, as ideias de contribuição poderão ser moldadas e adaptadas para encaixar no escopo da biblioteca.
+
+Dito isso, os potenciais contribuidores podem acessar o repositório oficial da biblioteca e iniciar seus respectivos desenvolvimentos.
+
+- :fontawesome-brands-github: [Repositório com código fonte](https://github.com/ThiagoPanini/pynvest)
+- :fontawesome-brands-python: [Página da biblioteca no PyPI](https://pypi.org/project/pynvest/)
+
+## Issues
+
+Abrir uma *issue* também é uma forma de contribuir com o projeto. Atualmente, existem alguns modelos específicos de *issues* que podem ser utilizados pelos usuários para fornecer insumos específicos sobre o projeto:
+
+- 🐞 Report de *bugs* da biblioteca
+- 📄 Aprimorando de documentações já existentes ou inclusão de novas páginas
+- 🚀 Requisição de novas funcionalidades para o projeto
+- 😵‍💫 Pedido de ajuda para tarefas no geral
+- 🤔 Questões ou dúvidas sobre o projeto

docs/overrides/home.html

@@ -25,7 +25,7 @@ <h1>
         <a href="{{ page.next_page.url | url }}" title="{{ page.next_page.title | e }}" class="md-button md-button--primary">
             Quick start
         </a>
-        <a href="{{ 'quickstart/instalacao/' | url }}" title="Material for MkDocs Insiders" class="md-button">
+        <a href="{{ 'scrappers/' | url }}" title="Material for MkDocs Insiders" class="md-button">
             Scrappers
         </a>
         </div>

docs/quickstart/arquitetura.md

@@ -37,4 +37,7 @@ Apresentada a estratégia de funcionamento, a biblioteca possui essa árvore de
     └───__init__.py
 ```
 
-> Aqui, é possível entender claramente a relação entre *scrappers* e portais de indicadores financeiros. O submódulo `fundamentus.py` contém funções, classes e métodos especialmente construídos para contemplar toda a dinâmica de extração e tratamento de dados contidos no site Fundamentus.
+<small>
+  :octicons-light-bulb-16:
+  **Dica:** Aqui, é possível entender claramente a relação entre *scrappers* e portais de indicadores financeiros. O submódulo `fundamentus.py` contém funções, classes e métodos especialmente construídos para contemplar toda a dinâmica de extração e tratamento de dados contidos no site Fundamentus.
+</small>

docs/quickstart/design.md

@@ -19,6 +19,11 @@ Referências visuais para construção do logo:
 
 A imagem na [home](../index.md) da documentação foi criada utilizando a ilustração [Financial Data Isometric](https://storyset.com/illustration/financial-data/amico) da página [storyset](https://storyset.com/).
 
+???+ tip "Sobre a conversão das imagens para a geração de ícones customizados"
+    Para conseguir gerar os logos customizados no cabeçalho da página, foi preciso realizar algumas etapas:
+
+    1. Converter a imagem PNG em um formato ICO utilizando as dimensões 32x32px ([cloudconvert](https://cloudconvert.com/png-to-ico))
+    2. Converter o arquivo ICO gerado para o formato SVG mantendo os *presets* de cores ([pixelied](https://pixelied.com/convert/png-converter/png-to-svg))
 
 ## Fontes
 
@@ -56,4 +61,6 @@ A imagem na [home](../index.md) da documentação foi criada utilizando a ilustr
 - [Dafont.com](https://www.dafont.com/)
 - [slidesgo](https://slidesgo.com/pt/)
 - [storyset](https://storyset.com/)
-- [Power Point](https://www.microsoft.com/en-us/microsoft-365/powerpoint)
+- [Power Point](https://www.microsoft.com/en-us/microsoft-365/powerpoint)
+- [cloudconvert](https://cloudconvert.com/png-to-ico)
+- [pixelied](https://pixelied.com/convert/png-converter/png-to-svg)

docs/quickstart/instalacao.md

@@ -4,8 +4,7 @@
     <br><img src="https://github.com/ThiagoPanini/pynvest/blob/v0.1.x/docs/assets/imgs/logo/logo-com-nome.png?raw=true" width=200 alt="pynvest-logo">
 </div>
 
-<div align="center">  
-  <br>
+<div align="center">
 
   <a href="https://pypi.org/project/pynvest/">
     <img src="https://img.shields.io/pypi/v/pynvest?style=flate&logo=python&logoColor=FFFFFF&color=22C7FF" alt="PyPi shield">

docs/scrappers/fundamentus/indicadores/acoes.md

@@ -1,6 +1,6 @@
 # Fundamentus: Indicadores de Ações
 
-De forma objetiva, a tabela abaixo contempla uma lista de indicadores financeiros (e suas respectivas definições/descrições) disponíveis no site e obtidos como resultado do método [coleta_indicadores_de_ativo()](../../../mkdocstrings/scrappers/fundamentus.md/#pynvest.scrappers.fundamentus.Fundamentus.coleta_indicadores_de_ativo).
+De forma objetiva, a tabela abaixo contempla uma lista de indicadores financeiros (e suas respectivas definições/descrições) disponíveis no site e obtidos como resultado do método [coleta_indicadores_de_ativo()](../mkdocstrings/fundamentus.md/#pynvest.scrappers.fundamentus.Fundamentus.coleta_indicadores_de_ativo).
 
 | **Nome Original** | **Atributo DataFrame** | **Descrição** |
 | :-- | :-- | :-- |

docs/scrappers/fundamentus/indicadores/fiis.md

@@ -1,6 +1,6 @@
 # Fundamentus: Indicadores de FIIs
 
-No portal Fundamentus, Fundos Imobiliários possuem seus próprios indicadores fundamentalistas. A tabela abaixo traz a visão daquilo que também é obtido pela chamada do método [coleta_indicadores_de_ativo()](../../../mkdocstrings/scrappers/fundamentus.md/#pynvest.scrappers.fundamentus.Fundamentus.coleta_indicadores_de_ativo) com *tickers* de FIIs.
+No portal Fundamentus, Fundos Imobiliários possuem seus próprios indicadores fundamentalistas. A tabela abaixo traz a visão daquilo que também é obtido pela chamada do método [coleta_indicadores_de_ativo()](../mkdocstrings/fundamentus.md/#pynvest.scrappers.fundamentus.Fundamentus.coleta_indicadores_de_ativo) com *tickers* de FIIs.
 
 | **Nome Original** | **Atributo DataFrame** | **Descrição** |
 | :-- | :-- | :-- |

docs/scrappers/about.md → docs/scrappers/index.md

@@ -1,4 +1,4 @@
-# Organização das Páginas
+# Scrappers
 
 A proposta desta seção é propor uma visão consolidada contendo todos os detalhes relacionados aos *scrappers* disponíveis para uso na biblioteca. A ideia é que cada *scrapper* tenha o seu próprio combo de documentação composto por:
 

docs/tools/arquitetura.md

@@ -0,0 +1,19 @@
+# Arquitetura de Solução
+
+Agora que temos uma noção sobre o que é o módulo `pynvest-tools` e os principais benefícios atrelados ao seu uso, vamos iniciar um aprofundamento técnico sobre o que está por trás da solução.
+
+Iniciando pela arquitetura, a imagem abaixo traz uma visão detalhada da solução contendo toda a dinâmica de serviços e integrações disponibilizadas para o usuário.
+
+<small>
+  :octicons-light-bulb-16:
+  **Dica:** clique na imagem para uma melhor visualização dos elementos.
+</small>
+
+![Arquitetura de Solução](https://github.com/ThiagoPanini/pynvest-tools/blob/v0.2.x/docs/drawio/pynvest-tool-diagram-print.png?raw=true)
+
+Em essência, o diagrama acima contempla todos os serviços AWS entregues pelo módulo Terraform e, além disso, traz a visão de todas as integrações entre os recursos.
+
+Toda a dinâmica de implantação do módulo é baseada em **6 macro etapas** que, em linhas gerais, contemplam toda a lógica de extração, preparação e atualização agendada dos dados financeiros disponibilizados ao usuário em seu próprio ambiente AWS.
+
+Ao longo desta seção de detalhamento, será possível observar todas as nuances e particularidades dos [recursos provisionados](./recursos.md) e das [etapas de processamento da solução](./processo.md). 
+