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

Severyn Kozak 71b66754b9 Move adv-search form buttons. Close #65 . Add: templates/index.html, static/sass/index.sass -Move the "add group" and "remove group" buttons inside the advanced-search form to a different location. static/img/index/ -Following convention established by the "about" page, all page-specific images should be located in a subdirectory of `static/img/` named after the page. Add `index` dir.		vor 10 Jahren
bitshift	Remove hard-coded file routes.	vor 10 Jahren
docs	Update some documentation.	vor 10 Jahren
parsers	Add parsing for import statements in java.	vor 10 Jahren
static	Move adv-search form buttons. Close #65.	vor 10 Jahren
templates	Move adv-search form buttons. Close #65.	vor 10 Jahren
test	Add mock python file.	vor 10 Jahren
.gitignore	Merge remote-tracking branch 'origin/develop' into develop	vor 10 Jahren
LICENSE	Fix names in license.	vor 10 Jahren
README.md	Update some documentation.	vor 10 Jahren
app.py	Add 404 page. Minor footer-style mod.	vor 10 Jahren
gunicorn.cfg	Update config file for violent horned mammals.	vor 10 Jahren
setup.py	Rewrite much of the indexer to use GitPython.	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.