Hello Abbas, if you are willing the share your code with the deal.II community, you can submit your code to the deal.II code gallery. The documentation for each of the example programs use the same doxygen formatting as deal.II. https://www.dealii.org/code-gallery.html https://github.com/dealii/code-gallery
Doxygen in general is a powerful tool to document your code, but other tools exist as well as for example Jupyter as you pointed out. I feel like it boils down to personal taste which one you would like to use. But kudos to you in thinking about documenting and sharing your code! Marc On Sunday, December 4, 2022 at 6:26:41 AM UTC-7 Abbas wrote: > Hello, > > Let's say you made 1000+ lines of code with dealii, and you want to > document and share it in a format similar to that of the dealii steps, how > would you go about doing this? > > MAYBE in the future people will share single "modules" with some > "tutorial" like documentation. This might be something some of us are > thinking about or considering. I guess? > > I have been suggested to use a jupyter notebook but I feel like that's a > huge waste of white space. Having a dedicated web link is also very > attractive so I was considering having a website hosted on github pages. I > tried that using Gatsby and it, but I feel like this is unnecessarily > over-complicated. > > Has anyone done something similar to this? If not, any ideas? > > Thank you for reading this far. > -- The deal.II project is located at http://www.dealii.org/ For mailing list/forum options, see https://groups.google.com/d/forum/dealii?hl=en --- You received this message because you are subscribed to the Google Groups "deal.II User Group" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/dealii/c1155573-c9b9-4061-95c4-95de1db760c1n%40googlegroups.com.
