codereport / jsource

J Language Source Code. Livestream links ⬇️
https://www.youtube.com/playlist?list=PLVFrD1dmDdvfVhYLU_iKkV67X9XqCJLWe
Other
38 stars 20 forks source link

Set up GitHub pages and link to Sphinx documentation #155

Open codereport opened 3 years ago

Sebanisu commented 3 years ago

Might need to move the docs folder to a raw_docs or raw/docs.

Because github pages kinda only can look at the docs folder or the root folder.

You need to copy the generated html into the new docs folder.

Add an empty file named .nojekyll this is because you aren't using jekyll.

How best to automate this? I'm not sure.

Sebanisu commented 3 years ago

You could always change set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/sphinx) to set(SPHINX_BUILD ${PROJECT_SOURCE_DIR}/docs) then when you build the docs it'd update the folder and you just need to commit the changes.