Update C and Fortran docs examples #97
Conversation
[skip ci]
[skip ci]
docs/source/example-c.rst
Outdated
|
|
||
| This directory is a starting point; | ||
| we'll make new directories under it as we proceed through the example. | ||
| In the end, | ||
| the directory structure under ``build`` should look like that in Figure 1. | ||
| the directory structure under ``example-c`` should look like that in Figure 1. | ||
|
|
||
| .. figure:: _static/babelizer-bmi-example-c.png |
There was a problem hiding this comment.
Instead of using a png for this, how about using the output of a tree command? Apart from looking better (in my opinion), it would be easier to keep up-to-date and would be one less binary file in version control.
There was a problem hiding this comment.
I'm thinking about removing it entirely because it's hard to maintain. It was a request from a reviewer on the JOSS paper.
…ture This hopefully makes the result clearer and removes a binary file from the repo. [skip-ci]
docs/source/example-c.rst
Outdated
| └── test | ||
| └── config.txt | ||
|
|
||
| 16 directories, 60 files |
There was a problem hiding this comment.
That's a lot of files. If we're going to keep this, maybe reduce the number of files printed to match the image we had for the JOSS review?
So the following for the top-level folder,
tree example-c -L 1 -F -aand then the following for a more detailed view of the bmi-example?
tree example-c/bmi-example-c -L 1 -F -aOr whatever's most useful to a reader.
There was a problem hiding this comment.
Got it. I have an idea of how this could work.
[skip-ci]
|
@mcflugen Are you OK with me removing |
|
@mdpiper & @mcflugen, thanks for your work to update the documentation to the new build examples! We're looking forward to trying this new workflow. Unfortunately, @Volk3rJ, @ptomasula, and I had quite a bit of trouble following your previous Babelizer documentation to build https://github.com/csdms/bmi-example-cxx. We're hoping for more success with this meson build approach. Is it in your roadmap to provide a C++ example? |
@aufdenkampe Would you be willing to add an issue requesting a C++ example for the docs? My hunch, based on working on the C and Fortran examples, is that we'll find problems to be fixed along the way. |
This PR revises the C and Fortran examples in the docs based on recent updates to the babelizer.
Two other minor changes are included here:
nox -s build-docsThis fixes #95.