Write docs

[riga]

Write doc strings and the structure for the doc pages.

Pages

• [ ] Tasks
• [ ] Targets
• [ ] Workflows
• [ ] Sandboxing
• [ ] Configuration
• [ ] Commandline Interface

API

• [x] cli
• [x] job
  • [x] base
  • [x] dashboard
• [ ] sandbox
  • [ ] base
  • [ ] bash
  • [ ] docker
  • [ ] singularity
• [ ] target
  • [ ] base
  • [ ] file
  • [ ] local
  • [ ] remote
  • [ ] collection
  • [ ] formatter
• [ ] task
  • [ ] base
• [x] workflow
  • [x] base
  • [x] local
  • [x] remote
• [x] config
• [x] decorator
• [x] parameter
• [x] logger
• [x] parser
• [x] patches
• [x] util

Contrib

• [ ] arc
• [ ] cms
• [ ] dropbox
• [ ] git
• [ ] glite
• [ ] htcondor
• [ ] keras
• [ ] lsf
• [ ] matplotlib
• [ ] mercurial
• [ ] numpy
• [ ] root
• [ ] tasks
• [ ] tensorflow
• [ ] wlcg

[choucavalier]

Note: In the documentation of Workflows, the concept of a "proxy" task is never really explained. Why do we need a proxy task? I read this 10 times and I still don't fully understand how workflows and proxy tasks work, nor when they should be used.

[riga]

Workflow proxies are a way to tell luigi not to use the run(), output() and requires() methods defined in the task itself by the user when branch is -1. In this case, all calls are forwarded to the workflow proxy's methods, which can do something completely different, depending on their workflow type.

Local workflows would just run their branches, whereas remote workflows (slurm, htcondor, etc.) would wrap them into jobs and submit them.

---

Side note: I'm currently writing a paper on law, which is why I'm closing some loose ends these days. I will eventually also finish the docs and add actual tests.