[Trac-dev] Re: Sphinx?

On May 21, 2008, at 6:51 PM, John Hampton wrote:
>
> Christian Boos wrote:
>> Noah Kantrowitz wrote:
>>> Yes, this was agreed on already AFAIK. All docs, docstrings, etc  
>>> will
>>> be ReST.
>>>
>
> <snip>
>
>> Also, be sure to find a replacement solution for the TracIniMacro and
>> MacroListMacro before converting the docstrings that are used by  
>> those
>> macros, i.e. the Option docstrings and the docstrings of  
>> WikiMacroBase
>> subclasses (more generally, the return value of  
>> get_macro_description()
>> was also supposed to be wiki markup up to now).
>
> So, for all this stuff, I hope we're not thinking about using ReST.
> While standardizing on ReST may be fine for the other stuff (though I
> still prefer wiki markup), the IniMacro and MacroList are valuable,  
> and
> doing that documentation in ReST is stupid (inmsho)

Now that I can actually get to a real keyboard, I can send an email. I  
am flipflopping on this and agree that anything in trac/ should stay  
wiki format. ReST will be confined to things in doc/. Moving to a Py3k- 
style hand-written API doc should also allow for more flexibility re:  
showing deprecated uses and such, and also solves another worry I had  
with moving the new docs to a branch. Sound better to people?

--Noah

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups "Trac Development" group.
To post to this group, send email to trac-dev <at> googlegroups.com
To unsubscribe from this group, send email to trac-dev-unsubscribe <at> googlegroups.com
For more options, visit this group at http://groups.google.com/group/trac-dev?hl=en
-~----------~----~----~----~------~----~------~--~---