aspect
aspect copied to clipboard
geodynamics
Document kaus 2010 block benchmark with sphinx
We (@cedrict and I) document the kaus 2010 block benchmark which already has a merged prm file (created by @naliboff). This time with sphinx and we incorporated the feedback from pull request #4608.
Before your first pull request:
- [x] I have read the guidelines in our CONTRIBUTING.md document.
For all pull requests:
- [x] I have followed the instructions for indenting my code.
There's nothing wrong with opening a new pull request, but out of curiosity, why didn't you just update the one in #4608? This way whoever reads through the history of a PR gets to see the whole history.
In the feedback of the other PR I was instructed to open a new one but yes next time I can also update it in the same PR
On 5/23/22 08:13, Marcel Saaro wrote:
In the feedback of the other PR I was instructed to open a new one but yes next time I can also update it in the same PR
Ah, I missed that. Sorry for the noise then!
@marcel112358 Thanks for reopening this! Before this will be rendered in sphinx, you will need to add your new kaus_2010_extension.md file to the index at the bottom of https://github.com/geodynamics/aspect/blob/main/doc/sphinx/user/benchmarks/index.md. Only once you do that, we will be able to see how it looks like in the html manual (you can see if it appear correctly yourself by clicking on the Details link next to the docs/readthedocs.org:aspect-documentation tester).
@naliboff Do you plan to review this since you already looked at the original version?
@jdannberg thank you for the feedback regarding the index file. I added it and I can see the page in the test documentation now.