Skip to content

Documentation

Pré-requisitos

Antes de começar, certifique-se de que você possui os seguintes pré-requisitos instalados em seu sistema:

  • Git: Para clonar o repositório.

Instalando o Python

Instale o Python 3.8 ou superior.

sudo apt install python3 python3-venv python3-pip
python3 --version

Instale o Python 3.8 ou superior.

brew install python
python3 --version

Instale o Python 3.13 ou superior. Baixe o instalador do site oficial do Python (https://www.python.org/downloads/) e execute-o. Certifique-se de marcar a opção "Add Python to PATH" durante a instalação.

python --version

Usage

Para utilizar o código deste repositório, siga as instruções a seguir:

Clone ou fork este repositório:

git clone <URL_DO_REPOSITORIO>

Crie um ambiente virtual do Python:

python3 -m venv env

python -m venv env

Ative o ambiente virtual (você deve fazer isso sempre que for executar algum script deste repositório):

source ./env/bin/activate

.\env\Scripts\activate

Instale as dependências com:

python3 -m pip install -r requirements.txt --upgrade

python -m pip install -r requirements.txt --upgrade

Deployment

O material utiliza o mkdocs para gerar a documentação. Para visualizar a documentação, execute o comando:

mkdocs serve -o

Para subir ao GitHub Pages, execute o comando:

mkdocs gh-deploy

Esse repositório possui um workflow do GitHub Actions que executa o comando mkdocs gh-deploy sempre que houver um push na branch main. Assim, não é necessário executar esse comando manualmente. Toda vez que você fizer um push na branch main, a documentação será atualizada automaticamente no GitHub Pages.

Aviso 1

Para que o github actions funcione corretamente, é necessário que o repositório esteja configurado para que o bot github-actions[bot] tenha permissão de escrita. Você pode verificar isso nas configurações do repositório, na seção "Actions" e depois em "General". Certifique-se de que a opção "Workflow permissions" esteja definida como "Read and write permissions".

Aviso 2

Depois de publicar, caso não consiga acessar a página, verifique se o github pages está configurado corretamente. Vá até as configurações do repositório, na seção "Pages" e verifique se a branch gh-pages está selecionada como fonte. Se não estiver, selecione-a e salve as alterações.

Pay Attention

No arquivo 'mkdocs.yml, a seção site_url deve estar configurada corretamente para o seu repositório. Por exemplo, se o seu repositório estiver em https://github.com/usuario/repositorio, a seção site_url deve ser:

site_url: https://usuario.github.io/repositorio

Também, certifique-se de que a seção repo_url esteja configurada corretamente para o seu repositório. Por exemplo:

repo_url: https://github.com/usuario/repositorio