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.
11 Incheckningar
2 Grenar
108 MiB
 
 
 
 
 
 
Träd: 0c68988982
Grenar Taggar
${ item.name }
Skapa branchen ${ searchTerm }
från '0c68988982'
${ noResults }
 ZIP  TAR.GZ
Ben Kurtovic 0c68988982 CREATE THE THINGS 10 år sedan
bitshift CREATE THE THINGS 10 år sedan
docs Adding basic sphinx documentation. 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 Adding basic sphinx documentation. 10 år sedan
LICENSE Fix names in license. 10 år sedan
README.md Fix __init__.py and add some info to README. 10 år sedan
app.py CREATE THE THINGS 10 år sedan
setup.py Basic setup.py. 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

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.