Iniciando

Apresentação

O intuito é auxiliar na reprodução da documentação realizada no projeto.

Pré-requisitos

A máquina deve conter python(preferência acima da versão 3.8) e pip.

Não tenho o pip, como baixar?

Atalho para o site: Pypi-pip

Como faço para instalar o Python?

Aqui nesse tópico passo alguns links: tutorial

Começando

Para iniciar a documentação apresentada, pode-se utilizar uma venv e o arquivo requirements.txt. Assim você possui um projeto reservado utilizando dos prós do ambiente virtual.

criar ambiente virtual

python -m venv .venv

ativar ambiente virtual

.\.venv\Scripts\Activate

Instalação dos requirements

pip install -r requirements.txt

Como usar o ambiente virtual?

criar:

python -m venv .venv

ativar:

.\.venv\Scripts\Activate

desativar:

deactivate

Iniciando Mkdocs

Após a execução do comando mkdocs serve, o servidor será iniciado e poderá ser acessado em http://127.0.0.1:8000.

Iniciando servidor local

mkdocs serve