Re: Documentation Unification and Awesomeification

2015-06-10 Thread Nic Bernstein
On 06/08/2015 07:43 PM, Nicola Nye wrote: Nice sleuthing work! Thanks! :-) The only alternative I have to offer is that much as Sphinx allows you to write custom themes to change the look and feel of the html, you can also write your own builder (or extend an existing one). http://sphinx-do

Re: Documentation Unification and Awesomeification

2015-06-09 Thread Nic Bernstein
On 06/09/2015 04:59 AM, Sebastian Hagedorn wrote: --On 8. Juni 2015 17:14:21 -0500 Nic Bernstein wrote: So here's my quandary: • I've found it completely impossible to produce standards-compliant man pages using ReStructuredText with the Sphinx/Docutils tool suite, without running into this p

Re: Documentation Unification and Awesomeification

2015-06-09 Thread Sebastian Hagedorn
--On 8. Juni 2015 17:14:21 -0500 Nic Bernstein wrote: So here's my quandary: • I've found it completely impossible to produce standards-compliant man pages using ReStructuredText with the Sphinx/Docutils tool suite, without running into this problem. • There's just no way I can find to wor

Re: Documentation Unification and Awesomeification

2015-06-08 Thread Nicola Nye
Hi Nic Nice sleuthing work! The only alternative I have to offer is that much as Sphinx allows you to write custom themes to change the look and feel of the html, you can also write your own builder (or extend an existing one). http://sphinx-doc.org/extdev/index.html#dev-extensions That would le

Re: Documentation Unification and Awesomeification

2015-06-08 Thread Nic Bernstein
On 05/19/2015 07:22 AM, Nic Bernstein wrote: # The Sphinx man page output can be unpredictable * Man output can sometimes shift to *bold* and never come back to normal. o See cyrus-docs/source/imap/admin/commands/unexpunge.rst for an example Nicola, et al., I've tracked do

Re: Documentation Unification and Awesomeification

2015-05-26 Thread Nic Bernstein
On 05/20/2015 10:34 PM, Nicola Nye wrote: I suggest you continue declaring your conventions on handling things in cyrus-docs (such as handling the revision data, along with the stylistic conventions) and throw up a note in the Phabricator wiki about how it's now all done, much as you did with t

Re: Documentation Unification and Awesomeification

2015-05-21 Thread Nic Bernstein
Nicola, Thanks for the follow up. I've not had any time for documentation lately, but have found some issues which need repair on the work I have done. I'll get that committed once it's clean. Given what you've said, below, I will stop changing the man pages in the cyrus-imapd repo. So far

Re: Documentation Unification and Awesomeification

2015-05-20 Thread Nicola Nye
Hi Nic, I am not (yet!) aware of much of the internals of imapd or sasl, so I think we have a good breakdown between us of input to add to the Cyrus docs. If you're able to unify and get the commands/config docs up to date, that is awesome. Bron added you as a committer to the cyrus-docs repo, so

Re: Documentation Unification and Awesomeification

2015-05-19 Thread Nic Bernstein
Nicola, et alia, [Apologies for top-posting, but it seemed appropriate here] Glad to see you jumping on board, and welcome! This all sounds good, and much needed. Something brought home to me by my recent push to harmonize man pages (between the two branches you've mentioned) is that the curr