diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index f62cc87d..00000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,13 +0,0 @@ -# Required -version: 2 - -build: - image: latest - -python: - install: - - requirements: ci/environment_pip.txt - -sphinx: - configuration: portal/conf.py - fail_on_warning: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fc7bed70..f92e5b13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,8 +94,10 @@ conda activate pythia conda update --all ``` -### To view the Read the Docs autobuild +### Preview the built site on Netlify -Once a Pull Request has passed all tests, including the Read the Docs build, you can click "Details" of the check that says, "docs/readthedocs.org:projectpythia - Read the Docs build succeeded!" to launch a new tab with a build of the Project Pythia site. (You may have to click "Show all checks" for this to be displayed.) +Once a pull request has passed all tests, including the `preview-site` check, the GitHub bot will post a comment with a preview link on the pull request. You can click on the link to launch a new tab with a build of the Project Pythia site. -![Checks](/portal/_static/images/ReadtheDocsAutobuild.png) +![CI-check](/portal/_static/images/deploy-site-CI-check.png) + +![Netlify Preview](/portal/_static/images/netlify-preview.png) diff --git a/ci/environment_pip.txt b/ci/environment_pip.txt deleted file mode 100644 index f897babf..00000000 --- a/ci/environment_pip.txt +++ /dev/null @@ -1,7 +0,0 @@ -myst-nb==0.12.3 -sphinx-book-theme -sphinx-panels -matplotlib -pandas -pyyaml -pre-commit diff --git a/portal/_static/images/ReadtheDocsAutobuild.png b/portal/_static/images/ReadtheDocsAutobuild.png deleted file mode 100644 index 25eec582..00000000 Binary files a/portal/_static/images/ReadtheDocsAutobuild.png and /dev/null differ diff --git a/portal/_static/images/deploy-site-CI-check.png b/portal/_static/images/deploy-site-CI-check.png new file mode 100644 index 00000000..5e3478a9 Binary files /dev/null and b/portal/_static/images/deploy-site-CI-check.png differ diff --git a/portal/_static/images/netlify-preview.png b/portal/_static/images/netlify-preview.png new file mode 100644 index 00000000..10812e55 Binary files /dev/null and b/portal/_static/images/netlify-preview.png differ