Hello all,

I recently submitted a patch for man page for NFS-Ganesha configuration 
options. 

I would like to suggest using sphinx tool for documentation. Similar to what 
ceph is using
https://github.com/ceph/ceph/tree/master/doc 

The doc can be written in ReStructured text markdown format, and can be 
compiled into various formats such as man, html,
pdf and latex. Its easier to maintain, and easier for others to change.

I have re-written the current patch in rst format. I have attached the rst file 
and man file generated using sphinx. I
am still working on the format. 

Let me know your thoughts. Going ahead, we can think of converting existing 
documents into rst.

Thanks,
Supriti 


------
Supriti Singh��SUSE Linux GmbH, GF: Felix Imend��rffer, Jane Smithard, Graham 
Norton,
HRB 21284 (AG N��rnberg)
 




Attachment: ganesha.rst
Description: Binary data

Attachment: ganesha_config.man
Description: Unix manual page

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
Nfs-ganesha-devel mailing list
Nfs-ganesha-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs-ganesha-devel

Reply via email to