A semantic search engine for source code https://bitshift.benkurtovic.com/
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
 
 
 
 
 
 
Ben Kurtovic e64c4924f4 API documentation, fixes, support not highlighting (closes #56). 10 år sedan
bitshift API documentation, fixes, support not highlighting (closes #56). 10 år sedan
docs Update some documentation. 10 år sedan
parsers Change parser commands into subprocesses rather than servers. 10 år sedan
static API documentation, fixes, support not highlighting (closes #56). 10 år sedan
templates API documentation, fixes, support not highlighting (closes #56). 10 år sedan
test API documentation, fixes, support not highlighting (closes #56). 10 år sedan
.gitignore parsing.jar, exclude. 10 år sedan
LICENSE Fix names in license. 10 år sedan
README.md Update some documentation. 10 år sedan
app.py API documentation, fixes, support not highlighting (closes #56). 10 år sedan
gunicorn.cfg Update config file for violent horned mammals. 10 år sedan
setup.py Rewrite much of the indexer to use GitPython. 10 år sedan

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.