search

EcoExtreML / STEMMUS_SCOPE

Integrated code of SCOPE and STEMMUS
https://ecoextreml.github.io/STEMMUS_SCOPE/
GNU General Public License v3.0
15 stars 6 forks source link

Add a mkdocs doc page #263

Closed SarahAlidoost closed 1 month ago

SarahAlidoost commented 1 month ago

The documentation can be published via github pages. and a github action to deploy it.

BSchilperoort commented 1 month ago

published via github pages

Why choose for gh pages instead of readthedocs? Just curious. Usually we use rtd.

SarahAlidoost commented 1 month ago

published via github pages

Why choose for gh pages instead of readthedocs? Just curious. Usually we use rtd.

I’m aware that we’ve used rtd for other packages in ecoextreml, but in some other projects, we’ve also used GitHub Pages. GitHub Pages is simpler in that it doesn’t require an additional configuration file like .readthedocs.yaml or the need to use a separate account interface. For this repository, I think gh Pages should be sufficient. But, if you have any specific reasons to prefer rtd, please let me know.