Documentação

🖥️ Requisitos:

• Nativo
  • Python 3.11
  • Pip
• Docker
  • Linux ou Docker Descktop
  • Docker
  • Docker-Compose

---

Instalação nativa

Instalação dos requisitos

pip install -r requirements.txt

Execução do servidor

mkdocs serve

Deploy da documentação

mkdocs gh-deploy

---

Instalação do Docker e Docker-compose

Caso não tenha o docker instalado, siga estes comandos para instala-lo, estes comandos são para distribuições Debian e Ubuntu.

Instalação do Docker

sudo apt update

sudo apt install apt-transport-https ca-certificates curl software-properties-common

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"

sudo apt install docker-ce

Verificação se o serviço foi instalado e está funcionando.

sudo service docker status

Adicionando seu usuario ao grupo docker.

sudo usermod -aG docker ${USER}

Aqui ele irá pedir a senha do seu usuario.

su - ${USER}

Instalação do Docker-compose

wget https://github.com/docker/compose/releases/download/v2.11.2/docker-compose-linux-x86_64

mv docker-compose-linux-x86_64 docker-compose

chmod +x docker-compose

sudo mv docker-compose /usr/local/bin/

Para verificar se o docker-compose foi instalado, execute o comando, se estiver tudo certo, irá apresentar a versão do aplicativo.

docker-compose --version

---

🛠️ Configuração

1.1 Começaremos clonando o repositorio do projeto:

git clone [email protected]:rubeus-tecnologia-e-inovacao/docs.git

1.2 Logo após terminar os passos anteriores, devemos criar a imagem do docker para a documentação, nesta imagem contém todas a dependencias necessarias para rodar o projeto.

(Deve demorar alguns minutos para a conclusão da montagem da imagem.)

docker build -t mkdocs-material .

Para rodar o servidor do mkdocs

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs mkdocs-material

Para verificar se realmente o serviço está funcionando, no navegador, abra: http://localhost:8000

Para rodar o gh-deploy e fazer o deploy da documentação

docker run --rm -it -v ~/.ssh:/root/.ssh -v ${PWD}:/docs mkdocs-material gh-deploy