Hi Logan,
Yes, the site runs on moinmoin. However I am not convinced that moinmoin is the way to go, maybe also those pages could be based on sphinx, what do you think? We could maintain them in a git repository easily, so that the examples could be downloaded and tried-out by anyone.
Logan Sorenson wrote:
>> I think we should setup also a page where users could post their
>> examples/applications. Something like what we do at sfepy.kme.zcu.cz
>> site, but open for everybody.
>>
>>
> This is a really good idea. Since that page looks like it runs on moinmoin,
> do you think it's possible to simply copy it over to another host and then
> open it up for everyone? Does anyone know if github supports moinmoin?
It is possible, see the notes below. I am open to alternatives, though - all I am persuaded is that we should use sphinx.
>>>> I would also like to set-up a sphinx-based documentation site for sfepy,
>>>> like [2] or [3], probably using github. Any volunteers out there? I have
>>>> made some attempts to learn how to do it, but have currently no time to
>> go
>>>> on. And yes, new functions added to sfepy are documented and use the
>>>> sphinx-compatible format, following the numpy's standards.
>>>>
>>> If no one else wants to volunteer, I can look into this. It would be good
>> to
>>> get someone with more experience with github/Sphinx to give some starting
>>> pointers.
>> This is how numpy guys do it:
>>
>> http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
>> http://svn.scipy.org/svn/numpy/trunk/doc/HOWTO_BUILD_DOCS.txt
>>
>>
> I looked a bit into github. I was able to setup a repository on github
> fairly easy, so hosting the docs is no problem on there. But I'm not sure
> how to do regular web hosting from the repository yet.
Sphinx is not setup for sfepy yet, so this is the first step to undertake. It would be great if you could give it a shot!
> I'm wondering a bit about the sphinx workflow. It seems like we should be
> able to autogenerate the docs from the sfepy source using sphinx. I was
> wondering if sphinx is already setup for sfepy, or should I work on that
> first? Once we get sphinx setup, can we just git pull sfepy, build the doc
> pages w/ sphinx, and the git push them to the documentation site? I'll try
> playing with the numpy source, so thanks for the
The site [2] says how to have both the source code and the documentation in the same directory, but without unwanted interference, see the 'Project Pages' section.
So I have founded the information - a success story [1] :), and how to setup github pages [2].
>> I have also some advice from Ondrej, I will post it here on Monday, as
>> I that information is on my workplace computer only...
>>
>
> Ok, great!
[1] http://lists.xiph.org/pipermail/theora/2009-June/002328.html
[2] http://pages.github.com/
best,
r.