A semantic search engine for source code https://bitshift.benkurtovic.com/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Benjamin Attal 0a7cccc74c Change format of string returned from ruby server to correct symbol table format. 10 years ago
bitshift Implement /search.json route (#27) 10 years ago
docs Update some documentation. 10 years ago
parsers Change format of string returned from ruby server to correct symbol table format. 10 years ago
static Remove merge artifacts. Tweak hidden-info styles. 10 years ago
templates Remove merge artifacts. Tweak hidden-info styles. 10 years ago
test Add sort keys, fix a bug, add tests. 10 years ago
.gitignore Create lib/ structure, clean up js. 10 years ago
LICENSE Fix names in license. 10 years ago
README.md Update some documentation. 10 years ago
app.py Implement /search.json route (#27) 10 years ago
setup.py Parsing dates should work. 10 years ago

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.