[meta] Review and improve README and documentation
This issue is to plan which parts of the documentation currently need improvement.
To Do
-
#124 (closed) Configure sphinx to raise warnings as errors and adapt pipeline to show that warning - Can configure the job to allow failure, though
- Along this: Do some docstring cleanup
-
#134 (closed) Add a motivation and a statement of need (including the target audience) to the README, see below -
!135 (merged) Expand and adapt usage examples and test that the existing ones work - Ideally, include them from some test cases
-
#130 (closed) Carry over documentation from Utopia, generalising it in the process - This is beneficial mostly to the plotting guides
- Take care to document features implemented in #113 (closed) (
PlotHelper
)
- Take care to document features implemented in #113 (closed) (
- This is beneficial mostly to the plotting guides
-
Extend documentation -
#129 (closed) Review, adapt and extend "integration and customization guide", i.e. how dantro can be used in a project -
#133 (closed) Multidimensional data generation and plotting (postponed) -
#136 (closed) Write a documentation entry on the NetworkGroup
GraphGroup
usage
-
-
#135 (closed) Check the spelling (and grammar) throughout the files using e.g. grammarly. This should not be too much of a hastle and gets rid of unnecessary typos.
People involved
Edited by Utopia Developers