Hi,
Since you asked for some opinions, I'll give you mine :-) I think one very important aspect is maintainability, and documentation of the system you would put into place. This is especially important in case the maintainer of the site, that seems to be you, wants to hand over the work to someone else. In that sense the Github pages + static site generator (Pelican) is, in my humble opinion, a very good choice: plenty of documented examples are floating around on the web, and people can easily learn how to use it and deploy/update the site (I also run Github-pages + pelican for my personal rather inactive blog). I have not used Readthedocs so I can't comment on how easy/difficult it is to use. Although I agree with your argument against using an external site for the documentation, I think the advantages you name are very very strong points indeed (build hooks, docs for older versions). The easier it is to maintain (automatic build hooks for the different supported versions), the better. You could become bored quickly when maintaining the website/documentation builds is too laborious. You also mention Sphinx, and that might be a solid alternative: * website + documentation in one place * properly documented (Matplotlib, IPython, Scipy, Numpy are using it) * I like the simplicity of the Numpy/Scipy sites, but I agree they are not as fancy as the Rstudio site. However, I find simplicity and maintainability more important than a fancy design. Best regards, David On 29 December 2014 at 21:30, Gonzalo A. PEÑA CASTELLANOS < [email protected]> wrote: > Nowadays everyone is using Readthedocs for the documentation, which is a > really great service, but I do not like that you have to go to another > place to read the documentation of a project... but then this is just me. > Read the docs can work great by using the github webhooks and tags so that > the different versions of the documentation are taken into account. > > That was the motivation of my previous question. If we will only maintain > a single 'latest' documentation, then I could make a template for sphinx > that would then be "processed" by pelican so they could use the same theme, > look and site. > > This last option would be more work, but would make the site look > "beautiful" and consistent... or we could just go with the current hype at > readthedocs.... > > Any comments on this issue? > > -- > You received this message because you are subscribed to the Google Groups > "spyder" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To post to this group, send email to [email protected]. > Visit this group at http://groups.google.com/group/spyderlib. > For more options, visit https://groups.google.com/d/optout. > -- You received this message because you are subscribed to the Google Groups "spyder" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/spyderlib. For more options, visit https://groups.google.com/d/optout.
