ben
/
bitshift
spegling av https://github.com/earwig/bitshift
1
1
Förgrening 0
Kod Släpp 1 Aktiviteter
A semantic search engine for source code https://bitshift.benkurtovic.com/
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
22 Incheckningar
2 Grenar
4.3 MiB
 
 
 
 
 
 
Träd: ad3de0615f
Grenar Taggar
${ item.name }
Skapa branchen ${ searchTerm }
från 'ad3de0615f'
${ noResults }
 ZIP  TAR.GZ
Ben Kurtovic ad3de0615f Fix some typos in the schema. 10 år sedan
bitshift Remove languages table; add indexed field for codelet rank. 10 år sedan
docs Add Codelet, crawler dependencies to setup. 10 år sedan
static Add assets/config module, SASS files, templates. 10 år sedan
templates Add assets/config module, SASS files, templates. 10 år sedan
.gitignore Database schema, hashing module, some other things. 10 år sedan
LICENSE Fix names in license. 10 år sedan
README.md Add Codelet, crawler dependencies to setup. 10 år sedan
app.py Docstrings for Database methods; oursql dependency. 10 år sedan
schema.sql Fix some typos in the schema. 10 år sedan
setup.py Database schema, hashing module, some other things. 10 år sedan

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.