A semantic search engine for source code https://bitshift.benkurtovic.com/
Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.
 
 
 
 
 
 
Ben Kurtovic a5cc3537cb Credits. pirms 10 gadiem
bitshift Minor refactor of codelet. pirms 10 gadiem
docs Add Codelet, crawler dependencies to setup. pirms 10 gadiem
static Add assets/config module, SASS files, templates. pirms 10 gadiem
templates Add assets/config module, SASS files, templates. pirms 10 gadiem
.gitignore Adding basic sphinx documentation. pirms 10 gadiem
LICENSE Fix names in license. pirms 10 gadiem
README.md Credits. pirms 10 gadiem
app.py CREATE THE THINGS pirms 10 gadiem
setup.py Add Codelet, crawler dependencies to setup. pirms 10 gadiem

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.