bqth29 / simulated-bifurcation-algorithm

Python CPU/GPU implementation of the Simulated Bifurcation (SB) algorithm to solve quadratic optimization problems (QUBO, Ising, TSP, optimal asset allocations for a portfolio, etc.).
MIT License
103 stars 25 forks source link

Add ReadTheDocs documentation #47

Closed bqth29 closed 8 months ago

bqth29 commented 8 months ago

💬 Pull Request Description

This pull request adds sphinx documentation files in the /docs directory that is automatically deployed on Read The Docs.

codecov[bot] commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (adaf9ff) 100.00% compared to head (b2b18fc) 100.00%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #47 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 36 36 Lines 1595 1600 +5 ========================================= + Hits 1595 1600 +5 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.