Feature/sbachmei/mic 3923 build docs to readthedocs

[stevebachmeier]

Title: Build docs on readthedocs

Description

• Category: documentation
• JIRA issue: MIC-3923

Added a required config file as well as the webhook to this repo on buildthedocs.

Testing

Docs were built (currently pointed at this branch - need to change it to
main when this merges)

https://pseudopeople.readthedocs.io/en/latest/

[albrja]

Do we want this or 3.10?

[stevebachmeier]

I doubt it matters as long as docs get built (and we DO support 3.8). This file was just copied from vivarium and I figure if it ain't broke, don't fix it

[rmudambi]

Does it work with 3.10? If so, we should use it.

[stevebachmeier]

will try.

[rmudambi]

Does it work with 3.10? If so, we should use it.

[ramittal]

Nice work, are there any additional steps needed to publish to readthedocs.io? or should we add these steps to deploy.yml?
Would be useful to write the steps you completed on hub to publish docs, so anyone can follow the same steps to publish docs for other repos in future as needed, and avoid investigation.

[ramittal]

we should also add install and next steps in getting started.

[stevebachmeier]

@ramittal

we should also add install and next steps in getting started.

I agree but that's not this ticket.

Nice work, are there any additional steps needed to publish to readthedocs.io? or should we add these steps to deploy.yml? Would be useful to write the steps you completed on hub to publish docs, so anyone can follow the same steps to publish docs for other repos in future as needed, and avoid investigation.

I don't think there are any steps needed, though I'm not familiar with how this doc-building stuff works at all. It seems to match our other repos so I think it should just work? We do have the docs getting made in our build.yml so I think that working in conjunction with the newly-added webhook will do the magic?

I added the basic steps I took to the ticket itself but it was pretty obvious once logged on. The only tricky part was passing 2fa to log into readthedocs.