Hello everybody.

I don't know if this is the correct place to ask the question, but I'll try
:)

I have documented a couple of projects made in Python, but now I have one
written in C. Reading the Sphinx doc I have seen that Sphinx supports C
directives, which is very interesting as it would make possible to document
my C project in Sphinx.

To create the API reference of my Python projects, I have a script that
generates the corresponding rst file for each python module and the
index.rst file for each folder. Then, building the project in Sphinx I
obtain the API reference for all my Python modules in an easy and beautiful
way including the index of each folder.

My problem now is that I would like to do something similar with my C
project. It is, I would like to automatically create an rst file for each C
and H file and the index file for each folder. Reading over internet I found
a project called *Breathe* which links Doxygen with Sphinx. I have tried it
but the result I have obtained is not as good as I expected. It lists the
contents of all the c files which compose my project in the same page and it
doesn't generate the general main index nor the module index page. BTW, the
Breathe directive I use is this (filling it with my project details):

.. doxygenindex::
   :project: ...
   :path: ..

But as said, it creates a file displaying the contents of every C file
one after another.

So, my question is... Does Breathe has any kind of script to create
the rst file of each C and H file? Or... how could I create such kind
of script? I would like to have separate rst files for each C files
and maintain the folder structure of my project...

Thanks all!

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

Reply via email to