Use Epytext for our inline documentation.

Driftwood2D / Driftwood

Driftwood 2D Tiling Game Engine and Development Suite

http://tileengine.org/

MIT License

23 stars 1 forks source link

Use Epytext for our inline documentation. #208

Open seisatsu opened 6 years ago

seisatsu commented 6 years ago

DAUX does not support generating API documentation. For this we should edit our comments to be compatible with a standalone API documentation generator project like pydoctor. Then link the API documentation from our manual as the API Reference chapter.

seisatsu commented 6 years ago

Specifically, this is the format to be employed for inline documentation. http://epydoc.sourceforge.net/epytext.html

seisatsu commented 6 years ago

Nevermind, Pydoctor doesn't work on Python 3. I will find an alternative, probably that uses Epytext anyway.

seisatsu commented 6 years ago

May want to return to sphinx.