search

sisl / AutomotiveDrivingModels.jl

Driving simulation architecture for Julia
Other
63 stars 29 forks source link

docs to literate #77

Closed mattuntergassmair closed 4 years ago

mattuntergassmair commented 4 years ago

Documentation tutorials from markdown format to Literate format (allows including and testing and conversion to markdown&notebooks)

mattuntergassmair commented 4 years ago

work in progress, needs a few more fixes (will take care of it tomorrow)

coveralls commented 4 years ago

Coverage Status

Coverage decreased (-0.02%) to 80.589% when pulling 7efb076a8a1cb370784adbe63aa4f7f7314947ac on mattuntergassmair:docs_to_literate into 52740c541c5c5ef04b19a22184122a07b93dbf65 on sisl:master.

MaximeBouton commented 4 years ago

Something to be aware of, if we add AutoViz in the testing dependencies we will have a cycle!

mattuntergassmair commented 4 years ago

Something to be aware of, if we add AutoViz in the testing dependencies we will have a cycle!

That's correct, but since it is an extra dependency that's used for tests only I wouldn't think that's a problem, right? The only alternatives are 1. not running the tutorials as part of the test suite or 2. not doing any visualization in the tutorials, but I guess none of those options is desireable.

Do you think it would be better (in this context, and in general), to have a separate Project.toml for tests (i.e. tests/Project.toml just like for docs) rather than having it in the [extras] section? I am a bit confused about the best practices with regards to this

MaximeBouton commented 4 years ago

There is quite a lot going on on master and incorporate_rec. I would say we finish the work there, and fix the tutorials here + merge after?