A semantic search engine for source code https://bitshift.benkurtovic.com/
No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.
 
 
 
 
 
 
Severyn Kozak 647eaf2a4c Add _logo.sass, add logo to docs page. hace 10 años
bitshift Change parser commands into subprocesses rather than servers. hace 10 años
docs Update some documentation. hace 10 años
parsers Change parser commands into subprocesses rather than servers. hace 10 años
static Add _logo.sass, add logo to docs page. hace 10 años
templates Add _logo.sass, add logo to docs page. hace 10 años
test Add mock python file. hace 10 años
.gitignore Merge remote-tracking branch 'origin/develop' into develop hace 10 años
LICENSE Fix names in license. hace 10 años
README.md Update some documentation. hace 10 años
app.py Work on #74. Add docs route, partly-skeleton page. hace 10 años
gunicorn.cfg Update config file for violent horned mammals. hace 10 años
setup.py Rewrite much of the indexer to use GitPython. hace 10 años

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.