On Sep 30, 2009, at 3:53 AM, Dag Sverre Seljebotn wrote:
> Peter Alexander wrote:
>> One thing I'd like to have an idea of atm is if you'd like the entire
>> site to be more homogenous. A nice template/theme could run through
>> out the website. Maybe using Sphinx's index.html as the portal page
>> and then linking to tutorial, manual, howto's, wiki, trac, etc.. from
>> there. I not much of a web-site developer but I'm sure I could handle
>> a template and css well enough.
>>
> As far as *system* goes, I personally think the current system is
> great.
> It's more about *content*.
>
> Brain dump:
>
> I like the current system of:
>
> - cython.org: A *short*, single, static HTML page. It should be as
> short
> as possible, only providing the essential links ("what is Cython",
> docs,
> download, mailing list, authors & financial contributions). Everything
> else is either relevant to users and should go into docs, or community
> stuff/dynamic lists which should go into wiki.
>
> - docs.cython.org: Served by Sphinx (which can then also build static
> Windows help files, documentation we can ship etc. etc). Sphinx can
> contain tutorials, howtos etc. in addition to reference manual.
> http://docs.python.org is great; many parts, all of which are
> searchable
> together immedeately. (I like that better than docs.scipy.org).
>
> - wiki.cython.org: We need a wiki for day-to-day work, but it
> should be
> used as a place for documentation to a lesser degree than today.
>
> - trac.cython.org: Perhaps get the logo back up but I don't see any
> need
> to integrate it nicely into anything else myself.
>
> Most users will only see docs.cython.org and so layout *will* be
> uniform
> without us thinking about it. The documentation on the wiki should IMO
> be removed from there and replaced with links to docs.cython.org (once
> the contents is moved). The Cython Enhancement Proposals should
> have the
> relevant link to docs.cython.org prominently placed on top of them,
> but
> stay in the wiki.
>
> The way I see it, the wiki and trac are ideally (but not today) mostly
> for developers and active mailing list participants, and so a nice
> experience is less important. Everything that we want people to read
> should find their way into http://docs.cython.org.
+1 to all of the above. We should be more aggressive about making
tickets to moving content on the wiki to actual documentation when
things get stable.
> Part of the problem is that it was never documented how to change
> docs.cython.org (I can change the hg repo but how to publish the
> changes?), and so to get documentation for e.g. NumPy stuff out I
> needed
> to put it on the wiki (Gabriel did a single pull of the tutorial but
> it's outdated now).
>
> BTW the SciPy project can edit their Sphinx documentation through a
> web
> interface (but I don't think that's the end to start for us; a simple
> automatic generation when a push is made to hg.cython.org/cython-docs
> will get us far).
Currently, there's an .hg repo in docs.cython.org that I pull from
and build right there. I'm not sure how to set up the hooks to fire
on push (it can probably be done) or even if it's a good idea, but a
single script one can run to refresh all docs would be very useful.
http://trac.cython.org/cython_trac/ticket/383
- Robert
_______________________________________________
Cython-dev mailing list
[email protected]
http://codespeak.net/mailman/listinfo/cython-dev
