Skip to content

Commit

Permalink
Note that RTD doesn't quite support sphinx-js yet. Close #35.
Browse files Browse the repository at this point in the history
  • Loading branch information
erikrose committed Nov 30, 2017
1 parent 7729650 commit 7ba9bf1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ Example

A good example using most of sphinx-js's functionality is the Fathom documentation. A particularly juicy page is https://mozilla.github.io/fathom/ruleset.html. Click the "View page source" link to see the raw directives.

Fathom also carries a Travis CI configuration and a deployment script for building docs with sphinx-js and publishing them to GitHub Pages. Feel free to borrow them. However, `ReadTheDocs <https://readthedocs.org/>`_, the canonical hosting platform for Sphinx docs, now supports sphinx-js, so that's likely your best bet.
Fathom also carries a Travis CI configuration and a deployment script for building docs with sphinx-js and publishing them to GitHub Pages. Feel free to borrow them. However, `ReadTheDocs <https://readthedocs.org/>`_, the canonical hosting platform for Sphinx docs, now supports sphinx-js as an informal opt-in beta. Get ahold of someone by commenting on `this ticket <https://github.com/rtfd/readthedocs.org/issues/3069>`_, and ask them to switch your project to the `latest` Docker image, then wipe your build environment and rebuild.

Caveats
=======
Expand Down

0 comments on commit 7ba9bf1

Please sign in to comment.