Generate api docs for EESSI test suite

EESSI / docs

Documentation for the European Environment for Scientific Software Installations (EESSI)

https://eessi.github.io/docs

GNU General Public License v2.0

13 stars 31 forks source link

Open xinan1911 opened 2 months ago

xinan1911 commented 2 months ago

A dependency of this PR is on https://github.com/EESSI/test-suite/pull/192 as PR 192 resolves the build error for API docs

xinan1911 commented 1 month ago

@casparvl Adjusted the deploy and schedule. This is ready for test

casparvl commented 3 weeks ago

Just to log for myself: to test this, one needs to

Git clone this feature branch
Clone the test suite in an src subdir: mkdir src && cd src && git clone https://github.com/EESSI/test-suite.git
Run mkdocs serve -a localhost:<someport>
Create a reverse tunnel to that node using ssh -L <someport>:localhost:<someport> <host_running_mkdocs_serve>
Go to localhost:<someport> in your browser.