How would you document a step/code/module?

[Abbas]

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.  

[Marc Fehling]

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

[Abbas]

Thank you Marc for your input, 
Maybe I am just complicating things. 
If I ever make a good example/module in the future, I'll make sure to share it to the code gallery.