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.
 
 
 
 
 
 
Ben Kurtovic 08249e086e Fix __init__.py and add some info to README. 10 years ago
bitshift Fix __init__.py and add some info to README. 10 years ago
docs Adding basic sphinx documentation. 10 years ago
static Add assets/config module, SASS files, templates. 10 years ago
templates Add assets/config module, SASS files, templates. 10 years ago
.gitignore Adding basic sphinx documentation. 10 years ago
LICENSE Fix names in license. 10 years ago
README.md Fix __init__.py and add some info to README. 10 years ago
app.py Add assets/config module, SASS files, templates. 10 years ago

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.