Fix broken documentation links in Website

JacquesCarette / Drasil

Generate all the things (focusing on research software)

https://jacquescarette.github.io/Drasil

BSD 2-Clause "Simplified" License

142 stars 26 forks source link

Fix broken documentation links in Website #3011

Open cd155 opened 2 years ago

cd155 commented 2 years ago

The documentation links for the double pendulum are broken.

I feel it is odd that we need to change the make file to make generate a new doxygen file.

https://github.com/JacquesCarette/Drasil/blob/5ea03dd072b372fe2f09b14e0291d966d2b238a2/code/Makefile#L29-L31

In order to generate doxygen file for double pendulum, we have to move dblpendulum from EXAMPLES to SRC_EXAMPLES. Is it possible to move this to the Haskell level?

JacquesCarette commented 2 years ago

That's a really interesting question. I'm pretty sure that the current answer is 'no'. We don't have knowledge in Drasil about our own examples, nor own to build these things.

This would be a tiny bit of Drasil-in-Drasil. But if we make Drasil more modular (i.e. don't insist that everything comes with an SRS), then this might actually not be very hard to implement!

smiths commented 2 years ago

@JacquesCarette I didn't realize that we couldn't build an example without an SRS. I agree completely that we want to aim for something more modular. @tingyuw will not be building an SRS for her Jupyter notebooks, so that might give us the impetus to make things more modular.

JacquesCarette commented 2 years ago

I think we need a SystemDescription for most things. It's not quite an SRS, but it's much too close. #1086 touches on that somewhat. Right now, Drasil is very focused on being holistic (generate a whole system).