Yes, you first need to integrate it in a sphinx doc with some rst file. In addition, there is also a support of "fortran docstrings": http://relay.actimar.fr/~raynaud/vacumm/user.desc.fdoc.auto.html#optimize-the-process The documentation is quite limited on this aspect, especially for subroutine docstrings. In their case, it assumed that docstring have the following generic format:
! General description ! ! :Params: ! - **param**, *(shape) [**float**,**in**]* :: Param description. ! ! :Foo: Bar Usually, the params and options sections are filled automalically and placed as the first sections. If some parameters are manually described in the docstring, their describtion is updated. Other sections are created, like in these examples: http://relay.actimar.fr/~raynaud/vacumm/user.desc.fdoc.dom.html#f/special_stats Le mercredi 17 décembre 2014 16:38:02 UTC+1, German Salazar a écrit : > > Stephane: > > Thanks for such quick reply. > > I am afraid I still don't quite understand or it is not what I had in > mind. Nothing wrong with it, I do want to learn reStructuredText and write > documentation with it...but it looks like I need to duplicate > information...once inside the Fortran source as usual and once again in the > rst files for sphinx. > > A long time ago, I used robodoc...I simply added minimal markers inside my > Fortran sources and robodoc created html with the information inside the > Fortran sources...I did not need an index file or any other file with > documentation outside the Fortran source files. Granted, it was limited in > that it only took text...no markdown, no latex, no formulas; but it was > very useful, nevertheless; also, it was not a documentation manual at all > but just basically an API...but I only had to type the information once > inside the Fortran source and that's it. > > With this sphinx based tool...it seems to me that I don't add anything to > the Fortran source files; instead, I simply create a whole new file > separate from the sources...is this correct? If so, this is not quite > what I had in mind...I was looking for something more along the lines of > how docstrings in Python are used by sphinx to add to the documentation out > of the python sources themselves without having to duplicate > explanations...is it possible to do the same thing with Fortran? If so, > how would an annotated Fortran source look like? The link provided about > the fortran domain seems to show what goes inside the *.rst files but makes > no mention of what goes inside the Fortran files. > > Thanks, again. > > gsal > > > > > -- 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. For more options, visit https://groups.google.com/d/optout.
