0 votes

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?

asked Feb 21, 2018 in Gossip by mateusak (1,071 points)

1 Answer

0 votes
Best answer

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:

answered Feb 22, 2018 by rolfpancake (1,006 points)
selected Feb 22, 2018 by mateusak
Welcome to Godot Engine Q&A, where you can ask questions and receive answers from other members of the community.

Please make sure to read How to use this Q&A? before posting your first questions.