A semantic search engine for source code https://bitshift.benkurtovic.com/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Ben Kurtovic 28d07de930 Fix origin stuff. 10 年之前
bitshift Fix origin stuff. 10 年之前
docs Update some documentation. 10 年之前
parsers Can specify which port to run ruby server on. 10 年之前
static Consistency fix: Use Codelet.url instead of Codelet.code_url. 10 年之前
templates Remove merge artifacts. Tweak hidden-info styles. 10 年之前
test Adjust test for new language dict. 10 年之前
.gitignore Some fixes, mainly involving language detection. 10 年之前
LICENSE Fix names in license. 10 年之前
README.md Update some documentation. 10 年之前
app.py Fix missing import. 10 年之前
gunicorn.cfg Add gunicorn support. 10 年之前
setup.py Add gunicorn support. 10 年之前

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.