How to write a user guide to document your CFD code

In this article, we explore how we can provide a user guide for software projects that grow beyond their original scope so that a 1-page readme file may not be sufficient anymore. We will look at a package called Sphinx that helps us write a user guide by adding searching, navigation, and a table of …

How to write a user guide to document your CFD code Read More »