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ů.
 
 
 
 
 
 
Benjamin Attal 8e3edb8080 Minor style changes to search results. před 10 roky
bitshift Merge branch 'feature/db_search' into develop před 10 roky
docs Update some documentation. před 10 roky
parsers Add Rakefile task for running ruby parse server. před 10 roky
static Minor style changes to search results. před 10 roky
templates Search results are now code blocks. Used pygments to parse a block of code into html, and used html styles to highlight the text. před 10 roky
test Add sort keys, fix a bug, add tests. před 10 roky
.gitignore Create lib/ structure, clean up js. před 10 roky
LICENSE Fix names in license. před 10 roky
README.md Update some documentation. před 10 roky
app.py Add languages.json, integrate with languages.py. před 10 roky
setup.py Parsing dates should work. 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.

Releasing

  • Update __version__ in bitshift/__init__.py, version in setup.py, and version and release in docs/conf.py.