A semantic search engine for source code https://bitshift.benkurtovic.com/
No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.
 
 
 
 
 
 
Severyn Kozak 627c848f20 Add tested indexer. hace 10 años
bitshift Add tested indexer. hace 10 años
docs Add Codelet, crawler dependencies to setup. hace 10 años
static Add assets/config module, SASS files, templates. hace 10 años
templates Add assets/config module, SASS files, templates. hace 10 años
.gitignore Adding basic sphinx documentation. hace 10 años
LICENSE Fix names in license. hace 10 años
README.md Credits. hace 10 años
app.py CREATE THE THINGS hace 10 años
setup.py Add Codelet, crawler dependencies to setup. hace 10 años

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.