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

Ben Kurtovic 085fd62704 Database schema, hashing module, some other things.		10 년 전
bitshift	Database schema, hashing module, some other things.	10 년 전
docs	Add Codelet, crawler dependencies to setup.	10 년 전
static	Add assets/config module, SASS files, templates.	10 년 전
templates	Add assets/config module, SASS files, templates.	10 년 전
.gitignore	Database schema, hashing module, some other things.	10 년 전
LICENSE	Fix names in license.	10 년 전
README.md	Add Codelet, crawler dependencies to setup.	10 년 전
app.py	Docstrings for Database methods; oursql dependency.	10 년 전
schema.sql	Database schema, hashing module, some other things.	10 년 전
setup.py	Database schema, hashing module, some other things.	10 년 전

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

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.