search

exasim-project / NeoFOAM

WIP Prototype of a modern CFD core
20 stars 1 forks source link

Documentation skeleton #3

Closed HenningScheufler closed 4 months ago

HenningScheufler commented 9 months ago

Skeleton for the documentation. The site gets hosts if you go under settings/pages and select main/docs

HenningScheufler commented 9 months ago

Thanks a lot for kicking it off! Just had a quick look for now.

  • Is there any way to get a preview?
  • Also can you add a link/badge from the Readme.md

The documentation can be viewed with

cd docs jekyll serve

You need to install Jekyll

greole commented 9 months ago

I activated gh pages for the docs. Currently, it is deployed from the docs branch. See https://exasim-project.com/NeoFOAM/

HenningScheufler commented 9 months ago

Thanks a lot for kicking it off! Just had a quick look for now.

  • Is there any way to get a preview?

  • Also can you add a link/badge from the Readme.md

The badges should be the same syntax as in the readme

HenningScheufler commented 8 months ago

We can leave it on the docs branch; i fixed the date to 2023

HenningScheufler commented 7 months ago

It might makes more sense if we write developer facing documentation to use sphinx with breathe. So, we have the documentation and the automated c++ API in one tool. The current documentation is better for user facing documentation: An example can be found here: https://xtensor.readthedocs.io/en/latest/?badge=latest @bevanwsjones

bevanwsjones commented 7 months ago

It might makes more sense if we write developer facing documentation to use sphinx with breathe. So, we have the documentation and the automated c++ API in one tool. The current documentation is better for user facing documentation: An example can be found here: https://xtensor.readthedocs.io/en/latest/?badge=latest @bevanwsjones

Yes, I agree. We can extend later for users with tutorials etc. I did some documentation for Disa today, by with doxygen + github pages, I can't say that it is anything special. I really like 'readthedocs', sphinx, etc, but I am a complete novice at it, esp. in an automated fashion. In code though, and if possible, I suggest using 'modern' c++ documentation approaches (briefs, params, returns, etc) -> we/I can write a convension's doc to describe a standardised way of doing it.

greole commented 4 months ago

Since we now have a documentation system in place i close this PR.