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

Severyn Kozak f4b28e6178 Add file-ext regex rules, exception handlers. Add: bitshift/crawler/indexer.py -add two `try: except: pass` blocks, one to _decode() and another to GitIndexer.run(); bad practice, but GitIndexer has numerous unreliable moving parts that can throw too many unforseeable exceptions. Only current viable option. -add file-extension regex ignore rules (for text, markdown, etc. files) to _get_tracked_files().		10 yıl önce
bitshift	Add file-ext regex rules, exception handlers.	10 yıl önce
docs	Add Codelet, crawler dependencies to setup.	10 yıl önce
static	Add assets/config module, SASS files, templates.	10 yıl önce
templates	Add assets/config module, SASS files, templates.	10 yıl önce
.gitignore	Adding basic sphinx documentation.	10 yıl önce
LICENSE	Fix names in license.	10 yıl önce
README.md	Credits.	10 yıl önce
app.py	CREATE THE THINGS	10 yıl önce
setup.py	Add Codelet, crawler dependencies to setup.	10 yıl önce

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.