README.md

The docs built from master can be viewed here. Our template can be found here.

Building the docs

To build the docs, you'll need Sphinx, a theme and some other package

# Start by installing the required packages
pip install -r requirements/docs.txt

Then, you can build the docs and view it

cd docs/
# Build the docs
make html
# View it! (Change firefox by your favorite browser)
firefox build/html/index.html

If you rebuild the docs, don't forget to run make clean before it.

You can add this to your .bashrc, source it and run run_docs from the docs/ folder, that'll be easier.

alias run_docs='make clean; make html; firefox build/html/index.html'

Writing good docstrings

• Start with RST and Sphinx CheatSheet
• Cross-referencing Python objects
  • Linking to any method in the package :func:~mymodule.myclass.myfunc.
  • Linking to a method in the class :meth:mymethod.
• Writing Returns with multiple values

def trial(pair_wise_losses):
    r"""Trial docstring

    Args:
        pair_wise_losses: there is a dot in the beginning.

    Returns
        - :class:`torch.Tensor`:
          The loss corresponding to the best permutation of size $(batch,)$. and
          if I keep typing? It works?

        - :class:`torch.Tensor`:
          Notice that those two spaces, not a tab.
    """