diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml index 0d6b6decb..d44e3428c 100644 --- a/.github/workflows/publish_docs.yml +++ b/.github/workflows/publish_docs.yml @@ -31,6 +31,7 @@ jobs: with: target_branch: gh-pages build_dir: docs/_build/html + fqdn: docs.stingray.science jekyll: false env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/README.rst b/README.rst index 24d240e09..f2f64a3be 100644 --- a/README.rst +++ b/README.rst @@ -22,21 +22,21 @@ However, an equivalent widely-used package does not exist for X-ray timing: to d Stingray aims not only to fill that gap, but also to provide implementations of the most advanced spectral timing techniques available in the literature. The ultimate goal of this project is to provide the community with a package that eases the learning curve for the advanced spectral timing techniques with a correct statistical framework. -More details of current and planned capabilities are available in the `Stingray documentation `_. +More details of current and planned capabilities are available in the `Stingray documentation `_. Installation and Testing ------------------------ Stingray can be installed via `conda`, `pip`, or directly from the source repository itself. -Our documentation provides `comprehensive installation instructions `_. +Our documentation provides `comprehensive installation instructions `_. After installation, it's a good idea to run the test suite. -We use `py.test `_ and `tox `_ for testing, and, again, our documentation provides `step-by-step instructions `_. +We use `py.test `_ and `tox `_ for testing, and, again, our documentation provides `step-by-step instructions `_. Documentation ------------- -Stingray's documentation can be found at https://stingray.science. +Stingray's documentation can be found at https://docs.stingray.science/. Getting In Touch, and Getting Involved -------------------------------------- @@ -54,14 +54,14 @@ Even better: if you have code you'd be willing to contribute, please send a `pul Related Packages ---------------- -- `HENDRICS `_ provides a set of command-line scripts which use Stingray to perform quick-look spectral timing analysis of X-ray data. +- `HENDRICS `_ provides a set of command-line scripts which use Stingray to perform quick-look spectral timing analysis of X-ray data. - `DAVE `_ is a graphical user interface built on top of Stingray. Citing Stingray --------------- If you find this package useful in your research, please provide appropriate acknowledgement and citation. -`Our documentation `_ gives further guidance, including links to appropriate papers and convenient BibTeX entries. +`Our documentation `_ gives further guidance, including links to appropriate papers and convenient BibTeX entries. Copyright & Licensing --------------------- @@ -72,7 +72,7 @@ The code is distributed under the MIT license; see `LICENSE.rst `_ .. |Build Status Master| image:: https://github.com/StingraySoftware/stingray/workflows/CI%20Tests/badge.svg :target: https://github.com/StingraySoftware/stingray/actions/ .. |Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat - :target: https://stingray.science/stingray + :target: https://docs.stingray.science/ .. |Slack| image:: https://slack.stingray.science/badge.svg :target: http://slack.stingray.science .. |Coverage Status Master| image:: https://codecov.io/gh/StingraySoftware/stingray/branch/master/graph/badge.svg?token=FjWeFfhU9F