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

Benjamin Attal b6be2b94ad Search results are now code blocks. Used pygments to parse a block of code into html, and used html styles to highlight the text.		10 jaren geleden
bitshift	1) All unavailable line numbers and column numbers become -1.	10 jaren geleden
docs	Update some documentation.	10 jaren geleden
parsers	Add Rakefile task for running ruby parse server.	10 jaren geleden
static	Search results are now code blocks. Used pygments to parse a block of code into html, and used html styles to highlight the text.	10 jaren geleden
templates	Search results are now code blocks. Used pygments to parse a block of code into html, and used html styles to highlight the text.	10 jaren geleden
test	Java server tells python client how much data to read.	10 jaren geleden
.gitignore	Finalize base template/styling; add _variables.	10 jaren geleden
LICENSE	Fix names in license.	10 jaren geleden
README.md	Update some documentation.	10 jaren geleden
app.py	Add adv-search form, skeleton-pages.	10 jaren geleden
setup.py	Update some documentation.	10 jaren geleden

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.