/2020.2-Violeta-Documentacao

EPS-2020-2-G5

Para utilizar framework de documentação

Requisitos

  1. mkdocs
  2. mkdocs-material

obs: Instalar pelo pip versão do python 3.7 ou +;

Rodar local

Para rodar local bastar ir na pasta do projeto e e escrever: mkdocs serve todos arquivos que você modificar estarão atualizados em tempo real no seu servidor local.

Documentar

Lembre sempre que para documentar não basta apenas colocar o documento .md na pasta docs tem que lembrar de colocar o link para esse documento no mkdocs.yml para mais informações visite mkdocs page