Switch to netlify for main docs - Githubissues

machow / siuba

Python library for using dplyr like syntax with pandas and SQL

https://siuba.org

MIT License

1.16k stars 49 forks source link

Switch to netlify for main docs #387

Open machow opened 2 years ago

machow commented 2 years ago

Related to #382

PR #338 introduced netlify previews for viewing docs built from gh actions on PR. Now that's working, let's plan to switch away from readthedocs.org. There are three reasons for this:

rtd shows ads on your page
github actions allows finer grain control
we can show a deployment badge on PRs, making it easier to click into preview docs

Rules for docs deployment:

docs are generated in 4 situations
- branches starting with "docs"
- main branch
- PRs
- releases
releases should push docs to production
previews are named pr-{number}--siuba.netlify.app or {branch}--siuba.netlify.app
- note that branch is converted to a slug, e.g. feat/a -> feat-a

machow commented 1 year ago

now that we have necessary permissions from them, last step is to forward from readthedocs