Create docs folder

[niccokunzmann]

The documentation of the module should be in the docs folder.

• developing.md is one part of the documentation. Let's move it there.
• there should be an overview somewhere pointing to the sections in the documentation.

[artemrizhov]

Not sure about README. The root of the project is a good place for README so that anybody can find and read it.
Also I'm not sure the README file will be found by GitHub if it is in a subfolder.

[niccokunzmann]

If you are not sure, what do you suggest to remove the uncertainty? We can try it out.

[artemrizhov]

Sure we can try it out with GitHub. But it's hard to try it out with developers and users. We probably will never know if one will get some difficulties while searching for the README. So I'd leave README in the root as it do a lot of another developers (if not all of them).

[niccokunzmann]

I did not mean to move the README.rst to the docs folder. There should be a new README.rst in the docs folder to give the overview over the different docs files in the docs folder. If you look at the docs folder from the github site, then you see the README in the folder and what docs are available.

[artemrizhov]

Oh, if so then it probably should be index.rst. This seems traditional for the rst documentation index file. Maybe I'm wrong, then correct me please.

[niccokunzmann]

Sounds good. Changed it :)

[artemrizhov]

If you look at the docs folder from the github site, then you see the README in the folder and what docs are available.

However, I'm not sure GitHub can render index.rst by default. I'm also not sure index.rst makes sense for GitHub because it will probably fail on rendering cross-links in the rst format, so we will have to use plain http links. Finally, if you want to make all the documentation accessible on GitHub then it is probably better to add direct links to those pages just in the README in the root folder.

[niccokunzmann]

So be it.