Gitiles
Code Review Sign In
gerrit.opencord.org / bbsim / d2907e6cd58d4e04c72b99895630f137c2a958fb
commitd2907e6cd58d4e04c72b99895630f137c2a958fb[log] [tgz]
authorZack Williams <zdw@opennetworking.org>Fri Apr 03 10:23:02 2020 -0700
committerZack Williams <zdw@opennetworking.org>Fri Apr 03 10:23:06 2020 -0700
tree0c6950b47e6ec10fda1174c3ba16d5af5b0ceb1a
parentb5fc46a55691fed625cb54fb881385bee0091fef [diff]
[VOL-2876]

Documentation cleanup and more compliant swagger docs
Use newer voltha-docker-tools version
Update to python3 venv and Sphinx to build docs

Change-Id: I3fca61aef78e77a893419200502a8fae91135a4a
6 files changed
tree: 0c6950b47e6ec10fda1174c3ba16d5af5b0ceb1a
  1. .dockerignore
  2. .gitignore
  3. .gitreview
  4. .golangci.yml
  5. CODE_OF_CONDUCT.md
  6. Dockerfile.builder.dockerignore
  7. LICENSE.md
  8. Makefile
  9. README.md
  10. VERSION
  11. api/
  12. build/
  13. cmd/
  14. configs/
  15. docs/
  16. examples/
  17. go.mod
  18. go.sum
  19. internal/
  20. tests/
  21. tools/
  22. vendor/
README.md

BroadBand Simular (BBSim)

Build

BBSim is managed via a Makefile, plese run the following command to display all the available targets

make help

Documentation

More advanced documentation lives in here.

You can generate and browse the documentation by executing:

make docs

This project structure is based on golang-standards/project-layout.