ben
/
bitshift
mirror da https://github.com/earwig/bitshift
1
1
Forka 0
Codice Rilasci 1 Attività
A semantic search engine for source code https://bitshift.benkurtovic.com/
Non puoi selezionare più di 25 argomenti Gli argomenti devono iniziare con una lettera o un numero, possono includere trattini ('-') e possono essere lunghi fino a 35 caratteri.
17 Commit
2 Rami (Branch)
26 MiB
 
 
 
 
 
 
Albero (Tree): 085fd62704
Rami (Branch) Tag
${ item.name }
Crea branch ${ searchTerm }
da '085fd62704'
${ noResults }
 ZIP  TAR.GZ
Ben Kurtovic 085fd62704 Database schema, hashing module, some other things. 10 anni fa
bitshift Database schema, hashing module, some other things. 10 anni fa
docs Add Codelet, crawler dependencies to setup. 10 anni fa
static Add assets/config module, SASS files, templates. 10 anni fa
templates Add assets/config module, SASS files, templates. 10 anni fa
.gitignore Database schema, hashing module, some other things. 10 anni fa
LICENSE Fix names in license. 10 anni fa
README.md Add Codelet, crawler dependencies to setup. 10 anni fa
app.py Docstrings for Database methods; oursql dependency. 10 anni fa
schema.sql Database schema, hashing module, some other things. 10 anni fa
setup.py Database schema, hashing module, some other things. 10 anni fa

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.