Sphinx: Link each entity to its source code on github

[f0k]

This links each entity to its source file on github. This should make it a lot easier for people to suggest edits to docstrings.
Numpy tweaked this further (https://github.com/numpy/numpy/blob/master/doc/source/conf.py#L286), in two respects:

• They link to the correct line in the file, while this PR just links to the file per se.
• They link to the correct version of the source code, while this PR just links to the latest master.

It should be possible to copy and adapt their code, but I don't have the time now -- I'd welcome any PRs to my PR!

[benanne]

Looks good! It would be good to make it differentiate between master and release already, I have a feeling we'll forget about it if we wait until the release.

[f0k]

It would be good to make it differentiate between master and release already

Please have a look at the numpy code: They solve this via numpy.__version__. Maybe there's a different way when compiling online at readthedocs, but to produce the correct links locally, that's the way to go. I've added this to our release todo list: #74 (comment)

I have a feeling we'll forget about it if we wait until the release.

Yes, in any case I wouldn't merge this without copying in the code I linked to. Without links to the correct line number it would be a step back from what we have.

[f0k]

Rebased and amended. It now links to the correct line number in the correct file in the correct branch/tag. Ready for reviewing and merging.

[f0k]

This saves another version string update that could easily be missed; numpy does it the same way. Let's see how readthedocs thinks about that. I've read that you may need to configure readthedocs to use virtualenv.

[benanne]

Why would it work with virtualenv but not otherwise? I'm not sure how it's currently set up - there seem to be multiple virtualenv-related settings, some of them are enabled and some aren't. It's a bit unclear what they all do. I remember having to tinker with them for a while before everything would work, though.

[f0k]

This line requires "import lasagne" beforehand, maybe this is not universally fine. I also don't know exactly how Sphinx works. We can just merge and see what happens.

[benanne]

Fine by me :)

[benanne]

Not much to say about this as I'm not very familiar with how Sphinx works. Everything looks fine to me.

[f0k]

Okay, merged and crossing fingers.

/edit: It works!

[f0k]

Wait, it doesn't work for lasagne.layers, it thinks the definitions reside in lasagne/layers.py although they are defined in submodules imported in lasagne/layers/__init__.py. Sorry for not checking all the pages beforehand.