A semantic search engine for source code https://bitshift.benkurtovic.com/
Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
 
 
 
 
 
 
Ben Kurtovic 902d734c28 Update __init__.py. před 10 roky
bitshift Update __init__.py. před 10 roky
docs Adding basic sphinx documentation. před 10 roky
static Add assets/config module, SASS files, templates. před 10 roky
templates Add assets/config module, SASS files, templates. před 10 roky
.gitignore Adding basic sphinx documentation. před 10 roky
LICENSE Fix names in license. před 10 roky
README.md Fix __init__.py and add some info to README. před 10 roky
app.py CREATE THE THINGS před 10 roky
setup.py Basic setup.py. před 10 roky

README.md

bitshift

bitshift is a semantic search engine for source code.

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

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.