A semantic search engine for source code https://bitshift.benkurtovic.com/
Ви не можете вибрати більше 25 тем Теми мають розпочинатися з літери або цифри, можуть містити дефіси (-) і не повинні перевищувати 35 символів.
 
 
 
 
 
 
Severyn Kozak 647eaf2a4c Add _logo.sass, add logo to docs page. 10 роки тому
bitshift Change parser commands into subprocesses rather than servers. 10 роки тому
docs Update some documentation. 10 роки тому
parsers Change parser commands into subprocesses rather than servers. 10 роки тому
static Add _logo.sass, add logo to docs page. 10 роки тому
templates Add _logo.sass, add logo to docs page. 10 роки тому
test Add mock python file. 10 роки тому
.gitignore Merge remote-tracking branch 'origin/develop' into develop 10 роки тому
LICENSE Fix names in license. 10 роки тому
README.md Update some documentation. 10 роки тому
app.py Work on #74. Add docs route, partly-skeleton page. 10 роки тому
gunicorn.cfg Update config file for violent horned mammals. 10 роки тому
setup.py Rewrite much of the indexer to use GitPython. 10 роки тому

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.