search

mesh-adaptation / mesh-adaptation-docs

Documentation source for Animate, Goalie, and Movement
MIT License
1 stars 0 forks source link

Write developer docs on demos #27

Open jwallwork23 opened 1 month ago

jwallwork23 commented 1 month ago

We need detailed instructions on how to build the docs, as well as to tell both PR authors and reviewers to check they build successfully.

Perhaps we could also introduce CI tests to check sphinx formatting?

ddundo commented 1 month ago

Good idea. Maybe we could then try to separate out different modules here? At the moment a developer working only on animate still must install goalie and movement, and run all their demos, before being able to build the docs.

jwallwork23 commented 1 month ago

Maybe we could then try to separate out different modules here? At the moment a developer working only on animate still must install goalie and movement, and run all their demos, before being able to build the docs.

Sorry, please could you clarify what you mean by "separate out different modules here"?

ddundo commented 1 month ago

Sorry, please could you clarify what you mean by "separate out different modules here"?

Sorry, I imagined this as something like passing an optional argument to make html, e.g. make html module=animate which would only build the animate part of the docs. This would obviously not be a fully functional website build, but good enough for the developer to check locally that relevant things are working as they should.

My point is that if we require developers to build the docs, I think that we should make this as simple as we can. At the moment building docs requires installing all 3 modules (animate, goalie, movement) and takes about an hour since we have to run all their demos.

jwallwork23 commented 1 month ago

Hm okay good point. Yeah could probably do something like that.