see some examples for package gammu docs / manual github url [1] https://github.com/gammu/gammu/tree/master/docs/manual or download source from [2] http://sourceforge.net/projects/gammu/files/gammu/1.32.0/gammu-1.32.0.tar.gzand using ./configure make make html or make latexpdf (that build using sphinx) complete documents of gammu with lots example of what you talk. these docs (created with .rst files) you could see browser url [4] http://wammu.eu/docs/
2013/2/22 Eric Frederich <[email protected]> > Hello > I have a project I'm trying to document. > We have "handlers" written in Python and in C. > In Python I'd like to have the documentation for each function embedded in > the source. > For the C stuff I'm okay having a separate rst file for each C function. > > Below I pasted 3 of my files. index.rst, python_handlers.rst, and > c_handlers.rst > My main concerns are how it looks with latexpdf and with html. > I'd like for the C and Python handler documentation to be consistent. > With latexpdf this works fine but with html I noticed some differences. > When I click on Python Handlers I am brought to a page that has all of the > documentation embedded. This is what I want. > However, when I click on the C Handlers link I am brought to another index > and have to click on an individual handler. > I'd like the C to behave like the Python where I can have all of the > documentation in one web page. > > I found a way to do that by using the include directive but was unable to > find a way to build it without getting warnings. > If I use include rather than toctree I get the following... > > /home/eric/sphinx_test/handler3.rst:4: WARNING: duplicate C object > description of handler3, other instance in > /home/eric/sphinx_test/c_handlers.rst > checking consistency... /home/eric/sphinx_test/handler3.rst:: WARNING: > document isn't included in any toctree > > How can I achieve this without warnings? > > Thanks, > ~Eric > > > > index.rst > > .. Some Project documentation master file, created by > sphinx-quickstart on Thu Feb 21 15:11:51 2013. > You can adapt this file completely to your liking, but it should at > least > contain the root `toctree` directive. > > Welcome to Some Project's documentation! > ======================================== > > Contents: > > .. toctree:: > :maxdepth: 2 > > python_handlers > c_handlers > > Indices and tables > ================== > > * :ref:`genindex` > * :ref:`modindex` > * :ref:`search` > > python_handlers.rst: > > Python Handlers > =============== > > handler 1 > --------- > .. autofunction:: handler1.handler1 > > handler 2 > --------- > .. autofunction:: handler2.handler2 > > c_handlers.rst: > > C Handlers > ========== > > .. toctree:: > :maxdepth: 2 > > handler3 > > handler3.rst: > > handler 3 > ========= > > .. c:function:: void handler3(void) > > Documentation for handler 3 > This handler does things > > -- > You received this message because you are subscribed to the Google Groups > "sphinx-users" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To post to this group, send email to [email protected]. > Visit this group at http://groups.google.com/group/sphinx-users?hl=en. > For more options, visit https://groups.google.com/groups/opt_out. > > > -- gilberto dos santos alves +55.11.98646-5049 são paulo - sp - brasil -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/sphinx-users?hl=en. For more options, visit https://groups.google.com/groups/opt_out.
