A semantic search engine for source code https://bitshift.benkurtovic.com/

Severyn Kozak 450e7cec0b Add `datepicker` and `typeahead`, Add: static/sass/index.sass -Add style rules for `datepicker` and `typeahead` elements. templates/index.html -Add any class specifiers required by both libraries to their corresponding elements. -Add a hack-ish `script` tag containing setup for `typeahead`.		vor 10 Jahren
bitshift	1) All unavailable line numbers and column numbers become -1.	vor 10 Jahren
docs	Update some documentation.	vor 10 Jahren
parsers	Add Rakefile task for running ruby parse server.	vor 10 Jahren
static	Add `datepicker` and `typeahead`,	vor 10 Jahren
templates	Add `datepicker` and `typeahead`,	vor 10 Jahren
test	Java server tells python client how much data to read.	vor 10 Jahren
.gitignore	Finalize base template/styling; add _variables.	vor 10 Jahren
LICENSE	Fix names in license.	vor 10 Jahren
README.md	Update some documentation.	vor 10 Jahren
app.py	Add adv-search form, skeleton-pages.	vor 10 Jahren
setup.py	Update some documentation.	vor 10 Jahren

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.