MSA Docs
Sistema de documentação para o artigo Microservices Documentation Proposal.
Dependências
Configuração
Instalando o VirtualEnvWrapper
Recomendados a utilização de um ambiente virtual criado pelo módulo virtualenvwrapper. Existe um sítio virtual com instruções em inglês para a instalação que pode ser acessado aqui. Mas você pode também seguir o roteiro abaixo para a instalação do ambiente:
sudo python3 -m pip install -U pip # Faz a atualização do pip
sudo python3 -m pip install virtualenvwrapper # Instala o módulo virtualenvwrapperOBS: Caso não tenha acesso de administrador na máquina remova o sudo do
início do comando e adicione a flag --user ao final do comando.
Agora configure o seu shell para utilizar o virtualenvwrapper, adicionando essas
duas linhas ao arquivo de inicialização do seu shell (.bashrc, .profile, etc.)
export WORKON_HOME=\$HOME/.virtualenvs
source /usr/local/bin/virtualenvwrapper.shCaso queira adicionar um local específico de projeto basta adicionar uma terceira linha com o seguinte export:
export PROJECT_HOME=/path/to/projectExecute o arquivo de inicialização do shell para que as mudanças surtam efeito, por exemplo:
source ~/.bashrcAgora crie um ambiente virtual com o seguinte comando (colocando o nome que deseja para o ambiente), neste exemplo usarei o nome docs:
mkvirtualenv -p $(which python3) docsPara utilizá-lo:
workon docs
sudo python3 -m pip install pipenv
pipenv install # Irá instalar todas as dependências usadas no projetoOBS: Novamente, caso necessário, adicione a flag --user para fazer a
instalação do pacote do pipenv.
Iniciando o servidor MkDocs
Agora basta executar o comando abaixo para rodar o servidor do MkDocs localmente:
cd msa-docs/
mkdocs serveAcesse em um navegador o endereço http://127.0.0.1:8000 e seu servidor local do
MkDocs deve estar funcionando com live reloading para que você verifique as
modificações durante o desenvolvimento.