sampleproject
sampleproject copied to clipboard
pypa
docs in sampleproject missing
The sampleproject missing a sample for the documentation. Please add it.
New users don't know where to put the docs directory ....
@guettli I know this is a very old ticket, but are you referring to adding .rst docs and/or Sphinx? Is the README.md sufficient? If so, can this issue be closed?
I think OP is asking for an example of a docs directory with additional documentation beyond the README.md. I think they can also be markdown, though.
If you are new and clueless it is very helpful if you can copy a structure.
That's what this sampleproject is about. Or am I wrong?
So what about documention?
It would be very helpful to have an example (without the word "or" and without "it depends").
This was omitted originally because there was no consensus over what tool/structure/markup to use for documentation. I'm not sure if there is more consensus now.
That's what this sampleproject is about. Or am I wrong?
The original purpose was just to demonstrate those parts of packaging a project that everyone agreed on. But the purpose has changed since (after all, nowadays it's not even obvious that new projects should use setuptools). I guess now it's for whatever people want it to be for 🙂
