ben
/
bitshift
Mirror von https://github.com/earwig/bitshift
1
1
Fork 0
Code Releases 1 Aktivität
A semantic search engine for source code https://bitshift.benkurtovic.com/
Du kannst nicht mehr als 25 Themen auswählen Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
10 Commits
2 Branches
33 MiB
 
 
 
 
 
 
Struktur: 6a9598fe12
Branches Tags
${ item.name }
Erstelle Branch ${ searchTerm }
von „6a9598fe12“
${ noResults }
 ZIP  TAR.GZ
Ben Kurtovic 6a9598fe12 Basic setup.py. vor 10 Jahren
bitshift Fix __init__.py and add some info to README. 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 Add assets/config module, SASS files, templates. 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.