search

funkelab / motile

Multi-Object Tracker using Integer Linear Equations
https://funkelab.github.io/motile/
MIT License
24 stars 5 forks source link

Merge docs into the main branch #38

Closed tlambert03 closed 1 year ago

tlambert03 commented 1 year ago

This PR would put the docs folder in the main branch. It removes all of the build artifacts currently in the docs branch, leaving pretty much only the docs/source folder. It also puts the requirements to build docs into a docs extra in pyproject.toml. So, to test out the docs locally, one runs:

pip install -e .[docs]
make -C docs html
open docs/build/html/index.html

It adds a github action to build and deploy to github pages, (which is currently commented out until if/when this PR merges)

codecov-commenter commented 1 year ago

Codecov Report

Merging #38 (3d501e6) into main (8defb53) will not change coverage. The diff coverage is n/a.

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##             main      #38   +/-   ##
=======================================
  Coverage   77.12%   77.12%           
=======================================
  Files          28       28           
  Lines         752      752           
=======================================
  Hits          580      580           
  Misses        172      172

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.