python icon indicating copy to clipboard operation
python copied to clipboard

Use readthedoc instead of gh-pages?

Open haraldh opened this issue 5 years ago • 2 comments

What do you think about using readthedoc instead of gh-pages?

It's possible to trigger doc updating from the github repo to readthedocs.io.

readthedoc will automatically retrieve the doc source and build and publish the new one from github without manual handling:

  • https://docs.readthedocs.io/en/stable/connected-accounts.html

Originally posted by @4383 in https://github.com/varlink/python/pull/21#issuecomment-541814748

haraldh avatar Oct 16 '19 14:10 haraldh

@haraldh what's your opinion?

4383 avatar Oct 17 '19 16:10 4383

My main concern is, can we continue to use custom domain like https://varlink.org/python/?

Apparently if I understood it correctly the answer is yes:

  • https://docs.readthedocs.io/en/stable/custom_domains.html#custom-domain-support

Then we will have a similar result than gh-pages, without the manual deployment part.

Maybe we will have a more recent CSS by default and anyway I suppose we can customize it somewhere and continue to display the current CSS if needed.

4383 avatar Oct 17 '19 16:10 4383