A semantic search engine for source code https://bitshift.benkurtovic.com/
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.
 
 
 
 
 
 
Severyn Kozak 5b60352cd0 Add some documentation, clean up before merge. il y a 10 ans
bitshift Merge branch 'feature/style' into develop il y a 10 ans
docs Update some documentation. il y a 10 ans
parsers Stop ruby parser from failing. Add other parser fixes. Should be good il y a 10 ans
static Add some documentation, clean up before merge. il y a 10 ans
templates Add text to about page; fix copyright year. il y a 10 ans
test Add mock python file. il y a 10 ans
.gitignore Merge branch 'develop' into feature/style il y a 10 ans
LICENSE Fix names in license. il y a 10 ans
README.md Update some documentation. il y a 10 ans
app.py Add text to about page; fix copyright year. il y a 10 ans
gunicorn.cfg Update config file for violent horned mammals. il y a 10 ans
setup.py Add gunicorn support. il y a 10 ans

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.