A semantic search engine for source code https://bitshift.benkurtovic.com/

Ben Kurtovic 0c68988982 CREATE THE THINGS		vor 10 Jahren
bitshift	CREATE THE THINGS	vor 10 Jahren
docs	Adding basic sphinx documentation.	vor 10 Jahren
static	Add assets/config module, SASS files, templates.	vor 10 Jahren
templates	Add assets/config module, SASS files, templates.	vor 10 Jahren
.gitignore	Adding basic sphinx documentation.	vor 10 Jahren
LICENSE	Fix names in license.	vor 10 Jahren
README.md	Fix __init__.py and add some info to README.	vor 10 Jahren
app.py	CREATE THE THINGS	vor 10 Jahren
setup.py	Basic setup.py.	vor 10 Jahren

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.