[pypy-dev] docs on doc.pypy.org

[holger krekel]

On Tue, May 03, 2011 at 10:12 +0000, holger krekel wrote:
> On Tue, May 03, 2011 at 12:04 +0200, Antonio Cuni wrote:
> > On 03/05/11 11:55, holger krekel wrote:
> > > Hi all,
> > > 
> > > i created a CNAME for our use of pypy.readthedocs.org and so you can now
> > > reach pypy docs under the frontend URL of
> > > 
> > >     http://doc.pypy.org
> > > 
> > > It might be better to promote this link also from pypy.org so
> > > that URLs have a higher chance to remain valid even if we
> > > decide to move away from readthedocs some day.
> > 
> > yes, good idea.
> > Moreover, I think we should change the link from "Dev Documentation" to just
> > "Documentation", because it contains docs which are generally useful also for
> > users (e.g., the getting started, the papers, etc.)
> > 
> > Alternatively, we could have a heavier refactoring of the documentation and
> > have clearly separated sections for "user docs" and "dev docs".
> > 
> > > Moreover, we could see to have (another) sphinx setup for sphinx 
> > > setup for our current pypy.org so we can host it there as well, maybe
> > > under www.pypy.org -- we need to have a subdomain/CNAME as we cannot
> > > redirect the root domain to readthedocs.
> > 
> > I'm not a sphinx expert, but I don't think that the default layout (i.e., with
> > a sidebar on the left) is the best for the home page of pypy.org.
> 
> I think sphinx can be tuned to support pypy.org layout but i don't
> consider myself a sphinx expert either.  Maybe someone feels like helping 
> and trying with https://bitbucket.org/pypy/pypy.org/overview
> to put it into a sphinx format?

seems like there is a limitation:

    http://read-the-docs.readthedocs.org/en/latest/install.html#what-s-available

which i just hit while playing with rtfd and pytest docs :/
Maybe we can get ourselves whitelisted sometime.

holger