Commit c3e113a7 authored by Millian Poquet's avatar Millian Poquet
Browse files

[doc] sphinx: mark TODOs

parent 989c4b81
......@@ -3,4 +3,8 @@
Command-line Interface
.. todo::
Describe command-line interface.
How to get it (batsim --help).
Most common use cases.
......@@ -64,6 +64,11 @@ This can be done with ``nix-env --install``.
# Or experiment management tools...
nix-env -f -iA batexpe
.. todo::
Talk about the different available versions.
At least last stable and master upstream. Maybe link to the advanced Nix tutorial (doing a reproducible experiment) for custom builds.
Build it yourself
Batsim uses the CMake_ build system.
......@@ -3,4 +3,7 @@
.. todo::
Write documentation about energy-related output files.
Maybe include some visualization tools there (Millian's scripts in evalys).
......@@ -3,4 +3,9 @@
.. todo::
Write documentation about the main output files.
State that there is one line per job.
Describe all fields as precisely as possible.
......@@ -3,4 +3,9 @@
.. todo::
Describe the _schedule output file.
This file has only one entry for the whole simulation.
Describe all fields.
......@@ -18,6 +18,9 @@ Whenever an event which may require making decision occurs in Batsim in the simu
4. Batsim receives the reply
5. Batsim resumes the simulation, applying the decision which have been made
.. todo::
Fix wrong image scale on readthedocs.
.. image:: img/proto/request_reply.png
:scale: 100 %
:alt: Protocol overview
......@@ -3,4 +3,8 @@
Using Redis
.. todo::
Write Redis documentation.
- Redis conventions (what is stored here, existence of prefix)
- Link to CLI for giving parameters
......@@ -3,4 +3,9 @@
Doing a reproducible experiment
.. todo::
Write the "Doing a reproducible experiment" tutorial
It would showcase (advanced) Nix usage.
Why not reusing demo code here.
......@@ -3,4 +3,5 @@
Implementing your scheduling algorithm
.. todo::
Write the "Implementing your scheduling algorithm" tutorial
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment