Docforge documentation is gone! - Githubissues

CyprienBosserelle / BG_Flood

Numerical model for simulating shallow water hydrodynamics on the GPU using an Adaptive Mesh Refinment type grid. The model was designed with the goal of simulating inundation (River, Storm surge or tsunami). The model uses a Block Uniform Quadtree approach that runs on the GPU but the adaptive/multi-resolution/AMR is being implemented and not yet operational. The core SWE engine and adaptivity has been inspired and taken from St Venant solver from Basilisk and the CUDA GPU memory model has been inspired by the work from Vacondio _et al._2017)

GNU General Public License v3.0

34 stars 15 forks source link

Docforge documentation is gone! #75

Open CyprienBosserelle opened 1 year ago

CyprienBosserelle commented 1 year ago

Docforge is dead!

More precisely it is not maintained anylonger and the server is down (although source code is still avaiable) https://github.com/erez-o/docsforge

What else can we do

or use github action to do doxygen and push the html output to gh-pages: here

Alternatives could be:

hdoc

CyprienBosserelle commented 1 year ago

Crude documentation available here:

https://cyprienbosserelle.github.io/BG_Flood/

We need to:

[ ] update the Doxygenfile to get a better capture
[ ] Add a better structure to point to md files first
[ ] maybe add some custom CSS to get away from the ugly

CyprienBosserelle commented 1 year ago

CSS from here looks great

https://jothepro.github.io/doxygen-awesome-css/