Summary
This PR is a complete overhaul of the `octue` documentation. The docs are now high-level, much more comprehensive, and make it significantly easier to get started with the SDK.
<!--- SKIP AUTOGENERATED NOTES --->
Contents ([441](https://github.com/octue/octue-sdk-python/pull/441))
**IMPORTANT:** There is 1 breaking change.
Enhancements
- 💥 **BREAKING CHANGE:** Remove redundant `name` argument from `Child`
- Improve and simplify the template apps
- Improve CLI help text
- Remove redundant "logger" logic in `Serialisable`
- Remove `credentials` and `monitors` parameters from `Analysis` constructor
Fixes
- Use unique folder for output data in fractal template app
Dependencies
- Use latest docs packages and unify docs dependencies with those specified in `pre-commit-config.yaml`
- Add documentation dev dependencies to `pyproject.toml`
- Update `poetry.lock` file
Refactoring
- Rename fractal template
- Rename `Analysis.app_src` to `Analysis.app_source`
- Make file hashing in `Datafile` clearer
Testing
- Use non-existing and clearer names for test project and bucket
- Prefix created bucket names with test bucket name
Documentation
- Summarise SDK features on docs index page
- Update installation page
- Add repo, organisation, version, and copyright info to docs
- Dynamically get `octue` version to display in docs
- Add data containers page
- Summarise data container key features on their own pages
- Improve data containers' pages
- Add page on asking questions to digital twins
- Add digital twin creation page
- Remove old cloud path usages from docs
- Add link to deprecated code removal schedule
- Improve README
- Move contribution guidelines into separate doc and update it
- Add selected API documentation
- Link to automated API docs from manually-written docs
- Add info on how to install `hdf5` dependency with `poetry`
- Replace `Datafile` context manager with `Datafile.open` context manager in docs
- Link to template apps in docs
- Link to default dockerfiles in docs
- Add information about semver to version history page
- Add definitions to docs using a custom admonition
- Add example data container use cases
- Update `Service` docstrings
- Improve `Child` docstrings
- Improve logging page
- Remove outdated cloud storage docs
- Move information about `Analysis` instances into class docstring
- Link to Analysis API docs in creating services doc
- Improve `Analysis` docstring
- Merge deploying services page into creating services page
- Update licence to cover 2022
- Update `FilterContaine`r docstrings
- Simplify filter container documentation
- Move available filters into its own page
- Add documentation covering CLI
- Add documentation on running services locally
- Merge child services page into asking questions page
- Improve `Datafile.open` docstring
- Add authentication page to docs
---
Upgrade instructions
<details>
<summary>💥 <b>Remove redundant name argument from Child</b></summary>
Remove the `name` argument from the `Child` constructor and use name-based services.
</details>
<!--- END AUTOGENERATED NOTES --->