A semantic search engine for source code https://bitshift.benkurtovic.com/
您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符
 
 
 
 
 
 
Severyn Kozak 5b60352cd0 Add some documentation, clean up before merge. 10 年前
bitshift Merge branch 'feature/style' into develop 10 年前
docs Update some documentation. 10 年前
parsers Stop ruby parser from failing. Add other parser fixes. Should be good 10 年前
static Add some documentation, clean up before merge. 10 年前
templates Add text to about page; fix copyright year. 10 年前
test Add mock python file. 10 年前
.gitignore Merge branch 'develop' into feature/style 10 年前
LICENSE Fix names in license. 10 年前
README.md Update some documentation. 10 年前
app.py Add text to about page; fix copyright year. 10 年前
gunicorn.cfg Update config file for violent horned mammals. 10 年前
setup.py Add gunicorn support. 10 年前

README.md

bitshift

bitshift is a semantic search engine for source code developed by Benjamin Attal, Ben Kurtovic, and Severyn Kozak.

Branches

  • master: working, tested, version-numbered code - no direct commits; should only accept merges from develop when ready to release
  • develop: integration branch with unreleased but mostly functional code - direct commits allowed but should be minor
  • feature/*: individual components of the project with untested, likely horribly broken code - branch off from and merge into develop when done

Style

bitshift uses SASS for styling; compile the stylesheets to CSS with sass --watch static/sass/:static/css.

Documentation

To build documentation, run make html from the docs subdirectory. You can then browse from docs/build/html/index.html.

To automatically update the API documentation structure (necessary when adding new modules or packages, but not when adding functions or changing docstrings), run sphinx-apidoc -fo docs/source/api bitshift from the project root. Note that this will revert any custom changes made to the files in docs/source/api, so you might want to update them by hand instead.

Releasing

  • Update __version__ in bitshift/__init__.py, version in setup.py, and version and release in docs/conf.py.