ben
/
bitshift
kopie van https://github.com/earwig/bitshift
1
1
Vork 0
Code Publicaties 1 Activiteit
A semantic search engine for source code https://bitshift.benkurtovic.com/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
59 Commits
2 Branches
11 MiB
 
 
 
 
 
 
Tree: d88e68e16e
Branches Labels
${ item.name }
Maak branch ${ searchTerm }
van 'd88e68e16e'
${ noResults }
 ZIP  TAR.GZ
Benjamin Attal d88e68e16e Add dispatch 'parse' function to parser __init__.py. Basic code language identification as well. Included pycparser as a depedency. 10 jaren geleden
bitshift Add dispatch 'parse' function to parser __init__.py. Basic code language identification as well. Included pycparser as a depedency. 10 jaren geleden
docs Update some documentation. 10 jaren geleden
static Add assets/config module, SASS files, templates. 10 jaren geleden
templates Add assets/config module, SASS files, templates. 10 jaren geleden
.gitignore Add dispatch 'parse' function to parser __init__.py. Basic code language identification as well. Included pycparser as a depedency. 10 jaren geleden
LICENSE Fix names in license. 10 jaren geleden
README.md Update some documentation. 10 jaren geleden
app.py Merge branch 'develop' of github.com:earwig/bitshift into develop 10 jaren geleden
setup.py Update some documentation. 10 jaren geleden

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.