Documentação da API do VMPay

Descrição

Este é o projeto de documentação da API do VMPay.

Escrita em formato reStructuredText, gerada usando o Sphinx, hospedada no Read The Docs.

Instalando o Sphinx

Há uma documentação online de como instalar o Sphinx. Na documentação completa do Read The Docs também há muita coisa.

TL;DR: se você está no Linux, provavelmente você já tem o Python instalado. As últimas distribuições do Python já vem com o pip:

pip -h

Se não, basta instalar. Por exemplo:

sudo apt-get install python-pip

Instalado o pip, basta rodar:

sudo -H pip install sphinx sphinx-autobuild sphinx_rtd_theme

A versão do Sphinx utilizada neste projeto foi a 1.3.3 com o Python 2.7.10.

Integrando este projeto com o Read The Docs

Há um guia online de como integrar um projeto documentado com o Sphinx e hospedado no GitHub com o Read the Docs.

A integração deste projeto com o Read The Docs já foi feita. Ou seja, ao se dar um push para este repositório, a documentação online hospedada no Read the Docs é atualizada automaticamente.

Alterando a documentação

A documentação é gerada em HTML a partir dos arquivos .rst (reStructuredText):

1. Editar os arquivos .rst desejados. O guia rápido do reStructuredText tem todo o básico que se precisa saber;

2. Gerar a documentação em HTML:

   cd docs; make html

3. A documentação em HTML será gerada dentro do diretório build/html. Este diretório não é commitado, serve somente para verificação local;

4. Abrir o arquivo build/html/index.html no browser de sua preferência. Se estiver tudo ok, commitar e dar push para este repositório. A documentação será automaticamente gerada e disponibilizada no Read The Docs.

Onde ler a documentação da API do VMPay

A documentação em formato legível está aqui.