DOC: Autoreformat doc to conform to numpydoc.

[Carreau]

One thing which is misparsed by numpydoc is

     Returns
     -------
-    NoneType or :class:`~signac.sync.FileTransferStats`
+    NoneType or : class:`~signac.sync.FileTransferStats`
         Returns stats if ``collect_stats`` is ``True``, else ``None``.

Which I of course did not add; So that might be a bug in NumPyDoc.

Partial work toward #344

Types of Changes

• Documentation update
• Bug fix
• New feature
• Breaking change¹

Checklist:

• I am familiar with the Contributing Guidelines.
• I agree with the terms of the Contributor Agreement.
• My name is on the list of contributors.
• My code follows the code style guideline of this project.
• The changes introduced by this pull request are covered by existing or newly introduced tests.

[vyasr]

Hey @Carreau thanks for the PR! This looks to be a duplicate of #361, was that intentional?

[b-butler]

@Carreau should both PRs #362 and #361 be open?

[Carreau]

Let's close 361 as this one was done with a more recent version of velin; still working on the RST parsing to fix more stuff but I didn't had much time recently.

[b-butler]

Sounds good.

[csadorf]

@Carreau Did you have a chance to work on the RST parsing?

[Carreau]

Did you have a chance to work on the RST parsing?

tiny bit but not that much. I'm going to try applying to CZI EOSS4, for a related project that might need more work on RST parsing, I've also discovered https://github.com/stsewd/tree-sitter-rst which does a fairly good job and could be reused/contributed to.

[csadorf]

@Carreau Ok, thx for the update. Let's leave the issue open then. Please let us know if we can be of any assistance.

[bdice]

I looked at a recent version of velin (which now supports being used as a pre-commit hook) but some of its suggestions weren't what I expected and might negatively impact our Sphinx docs rendering. Specifically handling of *args. I'm going to close this PR, we can always come back to the idea later but this PR has been stalled for long enough.