bitshift
1.0.0
bitshift é um mecanismo de busca semântica para código-fonte desenvolvido por Benjamin Attal, Ben Kurtovic e Severyn Kozak. Este README é destinado apenas a desenvolvedores. Para uma visão geral do usuário do projeto:
master : código funcional, testado e com numeração de versão - sem commits diretos; só deve aceitar mesclagens do develop quando estiver pronto para lançardevelop : ramo de integração com código não lançado, mas principalmente funcional - commits diretos permitidos, mas devem ser menoresfeature/* : componentes individuais do projeto com código não testado e provavelmente terrivelmente quebrado - ramificar e mesclar no develop quando terminar bitshift usa SASS para estilo; compile as folhas de estilo para CSS com sass --watch static/sass/:static/css .
Para construir a documentação, execute make html no subdiretório docs . Você pode então navegar em docs/build/html/index.html .
Para atualizar automaticamente a estrutura da documentação da API (necessária ao adicionar novos módulos ou pacotes, mas não ao adicionar funções ou alterar docstrings), execute sphinx-apidoc -fo docs/source/api bitshift na raiz do projeto. Observe que isso reverterá quaisquer alterações personalizadas feitas nos arquivos em docs/source/api , portanto, você pode querer atualizá-los manualmente.
__version__ em bitshift/__init__.py , version em setup.py e version e release em docs/conf.py .
