Documentation tool?

:information_source: Attention Topic was automatically imported from the old Question2Answer platform.
:bust_in_silhouette: Asked By mateusak

I simply want to easily write my own docs. No import, no anything. Just open it up and write, and be able to organize it in a readthedocs style. I can’t find anything like this for the love of god. Anyone knows a tool like this?

:bust_in_silhouette: Reply From: rolfpancake

The “readthedocs style” can only be achieved with using Markdown or reStructuredText, Sphinx and the readthedocs theme.

If you want to write docs you have to be more specific:

  1. Do you want to document your API automatically? (parse function definitions, extracting docstrings etc.)
  2. Do you want to write your docs by hand? (for tutorials, overviews, how-to articles and such - also called wiki)

API Documentation
It manly depends on your language used:

  • Doxygen
  • Slate
  • Create your own docset for Zeal
  • Never used it myself but maybe the docgen-godot repo by TeddyDD could be interesting for you

Hand written docs
There are lots of possibilities and it really depends on your needs: