Sphinx Fortran Domain - a sphinx extension for documenting Fortran projects

Announcements
1

Hello everyone,

While the project has been public for a while I haven’t officially announced it here :

With this extension, all the nice features of Sphinx are easily usable to create beautiful documentation out of Fortran source codes.

You’ll find some examples here :

One can also use this extension mixed with those for other languages if needing to document a mixed language project.

Give it a spin with your own projects and let me know, contributions are more than welcomed here :

Note: the extension itself is not a parser, it can currently use either FORD or a regex based parser to do the job, other parser can be added as well. The parser can be set on the conf.py file at the source of the documentation section of your project.

Cheers,

6 Likes
2

Great work, @hkvzjal. I’m already using it for new projects I started.

1 Like
3

How is this compared to GitHub - SciFortran/sphinxfortran_ng: An improved version of the original sphinx-fortran python module · GitHub ?

4

Last time I tested that project it couldn’t build documentation for the projects I work with. Also, they build on top of numpy.f2py which imposes a large set of limitations.

1 Like
5

Is time to vibe code the entire documentation-generation stack into Fortran. :grimacing:

2 Likes
6

I would just call it programming. Programming, going forward, means code generated by AI agents, unless specified otherwise. The result can be completely sloppy, in which case you can call it vibe coding. Or the final quality can be equivalent (or better than) what you would write by hand, in which case we can just call it programming.

So: it’s time to program the entire documentation-generation stack into Fortran.

1 Like