release cotracker 2.0

docs/Makefile

@@ -0,0 +1,13 @@
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = _build
+O             = -a
+
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/source/apis/models.rst

@@ -0,0 +1,14 @@
+Models
+======
+
+CoTracker models:
+
+.. currentmodule:: cotracker.models
+
+Model Utils
+-----------
+
+.. automodule:: cotracker.models.core.model_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/apis/utils.rst

@@ -0,0 +1,11 @@
+Utils
+=====
+
+CoTracker utilizes the following utilities:
+
+.. currentmodule:: cotracker
+
+.. automodule:: cotracker.utils.visualizer
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/conf.py

@@ -0,0 +1,39 @@
+__version__ = None
+exec(open("../../cotracker/version.py", "r").read())
+
+project = "CoTracker"
+copyright = "2023-24, Meta Platforms, Inc. and affiliates"
+author = "Meta Platforms"
+release = __version__
+
+extensions = [
+    "sphinx.ext.napoleon",
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "sphinxcontrib.bibtex",
+]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
+}
+intersphinx_disabled_domains = ["std"]
+
+# templates_path = ["_templates"]
+html_theme = "alabaster"
+
+# Ignore >>> when copying code
+copybutton_prompt_text = r">>> |\.\.\. "
+copybutton_prompt_is_regexp = True
+
+# -- Options for EPUB output
+epub_show_urls = "footnote"
+
+# typehints
+autodoc_typehints = "description"
+
+# citations
+bibtex_bibfiles = ["references.bib"]

docs/source/index.rst

@@ -0,0 +1,29 @@
+gsplat
+===================================
+
+.. image:: ../../assets/bmx-bumps.gif
+    :width: 800
+    :alt: Example of cotracker in action
+
+Overview
+--------
+
+*CoTracker* is an open-source tracker :cite:p:`karaev2023cotracker`.
+
+Links
+-----
+
+.. toctree::    
+   :glob:
+   :maxdepth: 1
+   :caption: Python API
+
+   apis/*
+
+
+Citations
+---------
+
+.. bibliography::
+   :style: unsrt
+   :filter: docname in docnames

docs/source/references.bib

@@ -0,0 +1,6 @@
+@article{karaev2023cotracker,
+  title   = {CoTracker: It is Better to Track Together},
+  author  = {Nikita Karaev and Ignacio Rocco and Benjamin Graham and Natalia Neverova and Andrea Vedaldi and Christian Rupprecht},
+  journal = {arXiv:2307.07635},
+  year    = {2023}
+}