DyNet needs documentation! about dynet HOT 11 CLOSED

The chainer tutorial documents would be a good reference here:
http://docs.chainer.org/en/stable/tutorial/index.html

It looks like they used Sphinx.

from dynet.

This looks good I'll try to set up sphinx and submit a PR

from dynet.

Awesome, that would be great.

from dynet.

Started a stem of some documentation here:
https://github.com/clab/dynet/blob/master/doc/index.md

I think one easy way to proceed is by commenting the code, then creating a script to automatically convert the comments into .md format for use in these files.

from dynet.

Once #116 is merged, here's a TODO list :

• Fill reference manual for all useful functions
  • Optimizers
  • Operations
  • Builders
  • Minibatching
  • Multiprocessing
• Write contribution guidelines
  • documentation guidelines
  • coding guidelines

from dynet.

I rearranged the operations and started documenting some of them, hopefully this will be done soon.

from dynet.

@pmichel31415: Do you think that we can use BibTeX in readthedocs? I took a look briefly but wasn't familiar enough with how readthedocs works to figure out how to do it.

from dynet.

I'll take a look later this week

from dynet.

So I've been looking around a little bit for references and it doesn't seem very practical in doxygen and/or sphinx (there's basically no canonical way to include bibtex references in sphinx).

I think the best solution is to keep adding references manually. In Doxygen you can add a link to the article (that's what I did in training.h) with [article](link).

Or we could add a link to a "references" page in the sphinx doc (this would be a bit ugly but it would work).

from dynet.

Are we actually getting close to closing this? Of course there will always be some things that could use better documentation, but I think we've covered most of the major things, and anything remaining can be covered by individual issues. Thank you for the massive effort @pmichel31415

from dynet.

Yes we can close this

from dynet.