A semantic search engine for source code https://bitshift.benkurtovic.com/
Não pode escolher mais do que 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
 
 
 
 
 
 
Severyn Kozak 63dfa8277f Clean up style rules, improve positioning. há 10 anos
bitshift Merge branch 'feature/style' into develop há 10 anos
docs Update some documentation. há 10 anos
parsers Stop ruby parser from failing. Add other parser fixes. Should be good há 10 anos
static Clean up style rules, improve positioning. há 10 anos
templates Clean up style rules, improve positioning. há 10 anos
test Add mock python file. há 10 anos
.gitignore Merge branch 'develop' into feature/style há 10 anos
LICENSE Fix names in license. há 10 anos
README.md Update some documentation. há 10 anos
app.py Merge branch 'develop' into feature/style há 10 anos
gunicorn.cfg Update config file for violent horned mammals. há 10 anos
setup.py Add gunicorn support. há 10 anos

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.