A semantic search engine for source code https://bitshift.benkurtovic.com/
Você não pode selecionar mais de 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 5b60352cd0 Add some documentation, clean up before merge. 10 anos atrás
bitshift Merge branch 'feature/style' into develop 10 anos atrás
docs Update some documentation. 10 anos atrás
parsers Stop ruby parser from failing. Add other parser fixes. Should be good 10 anos atrás
static Add some documentation, clean up before merge. 10 anos atrás
templates Add text to about page; fix copyright year. 10 anos atrás
test Add mock python file. 10 anos atrás
.gitignore Merge branch 'develop' into feature/style 10 anos atrás
LICENSE Fix names in license. 10 anos atrás
README.md Update some documentation. 10 anos atrás
app.py Add text to about page; fix copyright year. 10 anos atrás
gunicorn.cfg Update config file for violent horned mammals. 10 anos atrás
setup.py Add gunicorn support. 10 anos atrás

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.