{{ReadTheDocs}} is a web service for hosting documentation online.
{{RTD}} is a web service for hosting documentation online.
They offer free web hosting for open source projects, sustained by [ethical advertising](https://docs.readthedocs.io/en/stable/advertising/ethical-advertising.html) that is inserted into pages.
They offer free web hosting for open source projects, sustained by [ethical advertising](https://docs.readthedocs.io/en/stable/advertising/ethical-advertising.html) that is inserted into pages.
These ads can also be removed with a [small monthly payment](https://readthedocs.org/sustainability/) to help sustain the project.
{{ReadTheDocs}} builds Sphinx websites, and does not support Jupyter Book directly.
{{RTD}} builds Sphinx websites, and does not support Jupyter Book directly.
However, you can [convert your book to a Sphinx website](../sphinx/index.md) in order to publish with {{ReadTheDocs}}.
However, you can [convert your book to a Sphinx website](../sphinx/index.md) in order to publish with {{RTD}}.
To publish your book with {{ReadTheDocs}}, follow these steps:
To publish your book with {{RTD}}, follow these steps:
1.**Get started with ReadTheDocs**.
1.**Get started with Read theDocs**.
To do so, follow [the ReadTheDocs tutorial](https://docs.readthedocs.io/en/stable/tutorial/index.html).
To do so, follow [the Read theDocs tutorial](https://docs.readthedocs.io/en/stable/tutorial/index.html).
Configure {{ReadTheDocs}} to host a website from your book's repository.
Configure {{RTD}} to host a website from your book's repository.
2.**Convert your book into a Sphinx site**.
2.**Convert your book into a Sphinx site**.
There are two ways to do this using the Jupyter Book CLI.
There are two ways to do this using the Jupyter Book CLI.
...
@@ -25,4 +26,4 @@ To publish your book with {{ReadTheDocs}}, follow these steps:
...
@@ -25,4 +26,4 @@ To publish your book with {{ReadTheDocs}}, follow these steps:
This is the file Sphinx uses to build your book.
This is the file Sphinx uses to build your book.
3.**Commit the `conf.py` file and push to your online repository**.
3.**Commit the `conf.py` file and push to your online repository**.
If you've configured {{ReadTheDocs}} correctly, it should now automatically build your book's HTML and host it online.
If you've configured {{RTD}} correctly, it should now automatically build your book's HTML and host it online.