ConvoKit is a toolkit for extracting conversational features and analyzing social phenomena in conversations. It includes several large conversational datasets along with scripts exemplifying the use of the toolkit on these datasets.
Use m2r2 instead of m2r since the latter has been abandoned and the former has some bug fixes that we need to build docs correctly
Rename /doc to /docs -- which is more standard for open source
Create a GitHub Actions Workflow (.github/workflows/build-docs.yml) for building docs automatically to replace our manual build-and-rsync process. This uses the Rsync Deployments action.
The GitHub workflow will run only when pushing the master branch, so we no longer have to build docs ourselves manually. It requires zissou user credentials, which can be stored securely in GitHub Actions Secrets.
Resolves #153.
@cristiandnm @jpwchang Let me know what are your thoughts on whose credentials we can add for this workflow. Ideally, some dummy account with read/write permissions for just the docs folders should be created, so we don't have to rely on any individual person's credentials.
This PR updates our docs building process:
m2r2instead ofm2rsince the latter has been abandoned and the former has some bug fixes that we need to build docs correctly/docto/docs-- which is more standard for open source.github/workflows/build-docs.yml) for building docs automatically to replace our manual build-and-rsync process. This uses the Rsync Deployments action.The GitHub workflow will run only when pushing the
masterbranch, so we no longer have to build docs ourselves manually. It requires zissou user credentials, which can be stored securely in GitHub Actions Secrets.Resolves #153.
@cristiandnm @jpwchang Let me know what are your thoughts on whose credentials we can add for this workflow. Ideally, some dummy account with read/write permissions for just the docs folders should be created, so we don't have to rely on any individual person's credentials.