diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f43f4e9..c2e0ba1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,3 @@ # Contributing -Please see our [contributing](https://WayScience.github.io/coSMicQC/main/contributing) documentation for more details on contributions, development, and testing. +Please see our [contributing](https://github.com/WayScience/coSMicQC/blob/main/docs/src/contributing.md) documentation for more details on contributions, development, and testing. diff --git a/docs/redirector.html b/docs/redirector.html index 819aac9..d57e8d8 100644 --- a/docs/redirector.html +++ b/docs/redirector.html @@ -3,10 +3,30 @@ - Redirecting... + -

If you are not redirected automatically, follow this link to the main page.

+

Redirecting... If you are not redirected automatically, try the main page or the backup page.

diff --git a/docs/src/contributing.md b/docs/src/contributing.md index 34a89fd..c0211a3 100644 --- a/docs/src/contributing.md +++ b/docs/src/contributing.md @@ -133,3 +133,6 @@ poetry run sphinx-build docs/src docs/build # (used in production) poetry run sphinx-multiversion docs/src docs/build ``` + +After the docs build, navigate the `docs/build` folder and open the HTML files with your browser. +Opening the `index.html` file which may be found in the base of `docs/build` or `docs/build/` will simulate the docsite experience through GitHub Pages.