sphinx-me é uma ferramenta Python que irá criar um escudo documentação Sphinx para o seu projeto e incluir o arquivo LEIA-ME como o índice de documentação & nbsp;. Ele lida com a extração dos dados de meta necessários, tais como o nome do projeto, o autor e versão do seu projeto para uso em seus documentos Esfinge.
Uma vez que você usar sphinx-me para construir seus documentos esfinge, então você pode adicionar seu projeto para o site Leia a documentação e ter README do seu projeto hospedado com um atrativo Sphinx tema documentação.
Nota: Seu arquivo README deve estar em um formato compatível reStructuredText.
Instalação
A maneira mais fácil de instalar sphinx-me é diretamente do PyPI usando pip ou setuptools, executando o respectivo comando abaixo:
pip instalar -U sphinx-me
ou:
easy_install -U sphinx-me
Caso contrário, você pode baixar sphinx-me e instalá-lo diretamente da fonte:
python setup.py install
Executar
sphinx-me será instalado como um script de todo o sistema, que pode ser executado a partir da linha de comando, enquanto no diretório raiz do seu projeto:
sphinx-me
Quando executado no diretório do seu projeto, ele irá criar um diretório docs com dois arquivos, o módulo conf.py esfinge, e um arquivo index.rst que incluirá README do seu projeto.
O módulo conf.py chama uma função de configuração do sphinx-me que configura o mínimo definições necessárias para seus documentos Esfinge.
- Projecto - o nome do diretório do seu projeto é usado.
- Versão - recuperado do arg versão de seu script setup.py, ou atributo __version__ do seu pacote.
- Direitos autorais - recuperado do arg autor de seu script setup.py, ou atributo __author__ do seu pacote
Requisitos :
- . Python
Comentários não encontrado