Adapt doc site from open ephys

[matiasandina]

The page is building but it's looking for an index.html on the repo that isn't being created or is not pushed to Github for some reason.

If you check here, https://github.com/open-ephys/shuttledrive-docs/tree/gh-pages, github actions is creating the index.html (and all other files) for the page to actually work.

Anyhow, right now it's not rendering as expected and we get a sort of 404 error. I think some of the config files are using open ephys info. I think we are not seeing the gh-pages branch because this line is trying to commit to the open ephys repo instead of this repo.

FED3/docs/.github/workflows/sphinx-build.yml

Line 44 in d8d7718

git clone https://github.com/open-ephys/shuttledrive-docs.git --branch gh-pages --single-branch gh-pages

I think there might be some token creation step that might also be missing:
See here where token is trying to be used to push to the gh-pages branch

FED3/docs/.github/workflows/sphinx-build.yml

Lines 52 to 58 in d8d7718

	# 3. Push changes to gh-pages branch (updates documentation page)
	- name: Push changes
	uses: ad-m/github-push-action@master
	with:
	branch: gh-pages
	directory: gh-pages
	github_token: ${{ secrets.GITHUB_TOKEN }}

Maybe this tutorial helps?

[ahleighton]

Hi! I took a look at the docs generation. A lot of the config was still set to Open Ephys repos etc., so I've adjusted that to FED3, and manually added a gh-pages branch with a nojekyll file; my fork now generates the doc site as expected.

[matiasandina]

Great, thank you so much for doing this. @KravitzLab Should we merge that branch and proceed with migrating the docs there?

[KravitzLab]

Yes! It would be great to start migrating the documentation from the FED3 Wiki there and figure out what holes we need to patch. Although I have to admit I'm still confused about how to edit the new docs site and I don't have time to dig in right now! Matias, if you have time to do anything that would be great. I'll have time in ~1 month to help out too!

…

________________________________ From: Matias Andina ***@***.***> Sent: Wednesday, September 7, 2022 8:29 AM To: KravitzLabDevices/FED3 ***@***.***> Cc: Kravitz, Alexxai ***@***.***>; Mention ***@***.***> Subject: Re: [KravitzLabDevices/FED3] Adapt doc site from open ephys (Issue #11) * External Email - Caution * Great, thank you so much for doing this. @KravitzLab<https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FKravitzLab&data=05%7C01%7Calexxai%40wustl.edu%7C008779750ce14e96bc4c08da90d4f20a%7C4ccca3b571cd4e6d974b4d9beb96c6d6%7C0%7C0%7C637981541515634317%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=RPxyP9zQB1dmWdzW%2BhP5wk%2BGIrUd1IeyVLrAzV5Ls9M%3D&reserved=0> Do we want to proceed with migrating the docs there? — Reply to this email directly, view it on GitHub<https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FKravitzLabDevices%2FFED3%2Fissues%2F11%23issuecomment-1239391984&data=05%7C01%7Calexxai%40wustl.edu%7C008779750ce14e96bc4c08da90d4f20a%7C4ccca3b571cd4e6d974b4d9beb96c6d6%7C0%7C0%7C637981541515634317%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=fTmlDoVQYR%2BBOHF7M1ZN1WHuKgIMq9wqB6WxzZiqtVE%3D&reserved=0>, or unsubscribe<https://nam10.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAD76MGOGDQVSQTNIVGIDG5DV5CKCHANCNFSM5SPQ7PPA&data=05%7C01%7Calexxai%40wustl.edu%7C008779750ce14e96bc4c08da90d4f20a%7C4ccca3b571cd4e6d974b4d9beb96c6d6%7C0%7C0%7C637981541515790556%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=ORLsCaZ%2FM6Ip73lA2eQoHlTAb2ezbjFx1o%2BRkpRg3qY%3D&reserved=0>. You are receiving this because you were mentioned.Message ID: ***@***.***>

________________________________ The materials in this message are private and may contain Protected Healthcare Information or other information of a sensitive nature. If you are not the intended recipient, be advised that any unauthorized use, disclosure, copying or the taking of any action in reliance on the contents of this information is strictly prohibited. If you have received this email in error, please immediately notify the sender via telephone or return mail.