A semantic search engine for source code https://bitshift.benkurtovic.com/
Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
 
 
 
 
 
 
Severyn Kozak d142f1fd55 Complete Crawler. Close #15, #14, #11, #8. před 10 roky
bitshift Complete Crawler. Close #15, #14, #11, #8. před 10 roky
docs Add Codelet, crawler dependencies to setup. před 10 roky
static Add assets/config module, SASS files, templates. před 10 roky
templates Add assets/config module, SASS files, templates. před 10 roky
.gitignore Adding basic sphinx documentation. před 10 roky
LICENSE Fix names in license. před 10 roky
README.md Credits. před 10 roky
app.py Commit latest crawler, continue fix of #8. před 10 roky
setup.py Commit latest crawler, continue fix of #8. před 10 roky

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.