Pyro: multiple versions of documentation, one per release (+dev)

Created on 10 Nov 2017  路  7Comments  路  Source: pyro-ppl/pyro

Having docs for varying versions, especially dev and master, sounds useful for development. I don't know if Pytorch has a good solution but I like that TF has multiple versions. FWIW, read the docs does this automatically: https://docs.readthedocs.io/en/latest/index.html.

relevant: https://github.com/uber/pyro/pull/545#issuecomment-343333425

documentation

Most helpful comment

How about hosting documentation / tutorials on readthedocs, and retaining our domain name - http://docs.readthedocs.io/en/latest/alternate_domains.html?

All 7 comments

we did this in webppl (using readthedocs) and it worked nicely. (all though it meant i pointed people to the dev docs most of the time ;)

unfortunately you can only do that if it is hosted on readthedocs.org. pytorch does this manually which is why they have this hacked together page. the problem with this is that, our doc files will scale with each release, which will be a lot of overhead when a user clones pyro.

How about hosting documentation / tutorials on readthedocs, and retaining our domain name - http://docs.readthedocs.io/en/latest/alternate_domains.html?

oo hm this seems new ill look into this

docs.pyro.ai (give 24 hours for CNAME to propagate)

Great!

  • Can we opt out of the ads (http://docs.readthedocs.io/en/latest/ethical-advertising.html#opting-out)? They seem kind of pesky.
  • Can we get our old CSS back?

Can we opt out of the ads

nope - i already opted out of paid ads but thats all we can do on the free tier

Can we get our old CSS back?

Go for it :)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jpchen picture jpchen  路  5Comments

fritzo picture fritzo  路  4Comments

robsalomone picture robsalomone  路  4Comments

neerajprad picture neerajprad  路  4Comments

martinjankowiak picture martinjankowiak  路  3Comments