This PR is a substantial overhaul of the documentation. I expect this to be the last major doc PR before the first release. This started by trying to write up the basic concepts (e.g., what's a "file", what's a "process") but I realized that was intertwined with a lot of other bits of the docs. This got a bit out of hand, and the diffs are going to be useless. The good news is that this brings the docs to a much better state than I was really shooting for originally.
As a rough summary, this PR:
Adds the basic concepts document ("concepts" from the front page).
Adds "Getting Started" document.
Scrubs all the docstrings and makes them numpydoc formatted consistently. I moved the API docs to the developer section as well.
Removes all the loose Notes, Readmes, etc. and other ad-hoc temporary documentation; it's all tied together in Sphinx now.
Scrubs all documentation for out-of-date and inaccurate information.
I'm not looking to make the documentation perfect here (we can do more later!) but I hope this is actually an improvement. Here are the rendered docs: pr112.zip ...it may be easiest to review by just reading through this.
PR Checklist
[X] Pull request has descriptive title
[X] Pull request gives overview of changes
[X] New code has inline comments where necessary
[X] (N/A) Any new modules, functions or classes have docstrings consistent with dbprocessing style
[X] (N/A) Major new functionality has appropriate Sphinx documentation
[X] (N/A) Added an entry to release notes if fixing a major bug or providing a major new feature
[X] (N/A) New features and bug fixes should have unit tests
[X] (N/A) Relevant issues are linked in the description (use Closes # if this PR closes the issue, or some other reference, such as See # if it is related in some other way)
This PR is a substantial overhaul of the documentation. I expect this to be the last major doc PR before the first release. This started by trying to write up the basic concepts (e.g., what's a "file", what's a "process") but I realized that was intertwined with a lot of other bits of the docs. This got a bit out of hand, and the diffs are going to be useless. The good news is that this brings the docs to a much better state than I was really shooting for originally.
As a rough summary, this PR:
I'm not looking to make the documentation perfect here (we can do more later!) but I hope this is actually an improvement. Here are the rendered docs: pr112.zip ...it may be easiest to review by just reading through this.
PR Checklist
Closes #if this PR closes the issue, or some other reference, such asSee #if it is related in some other way)