bitshift

位移位

bitshift 是由 Benjamin Attal、Ben Kurtovic 和 Severyn Kozak 开发的源代码语义搜索引擎。本自述文件仅供开发人员使用。有关该项目的用户概述：

• 阅读我们的关于页面
• 观看我们的演示视频

分支机构

• master ：工作的、经过测试的、版本编号的代码 - 没有直接提交；应该只在准备发布时接受来自develop的合并
• develop ：具有未发布但主要功能代码的集成分支 - 允许直接提交，但应该是次要的
• feature/* ：项目的各个组件未经测试，可能存在严重损坏的代码 - 完成后从开发中分支并合并到develop中

风格

bitshift 使用 SASS 进行样式设置；使用sass --watch static/sass/:static/css将样式表编译为 CSS。

文档

要构建文档，请从docs子目录运行make html 。然后您可以从docs/build/html/index.html进行浏览。

要自动更新 API 文档结构（添加新模块或包时需要，但添加函数或更改文档字符串时不需要），请从项目根目录运行sphinx-apidoc -fo docs/source/api bitshift 。请注意，这将恢复对docs/source/api中的文件所做的任何自定义更改，因此您可能需要手动更新它们。

释放

• 更新bitshift/__init__.py中的__version__ 、 setup.py中的version以及docs/conf.py中的version和release 。