4 ms·
Most languages now have a tool for writing and hosting documentation to make this as easy as possible for you. The author of the post runs http://readthedocs.or
by Lukasa 13y ago
Most languages now have a tool for writing and hosting documentation to make this as easy as possible for you. The author of the post runs http://readthedocs.org/ http://readthedocs.org/, which is primarily used by Python developers, for instance.
For Go, the standard toolchain is the builtin go doc tool (http://godoc.org/code.google.com/p/go.tools/cmd/godoc http://godoc.org/code.google.com/p/go.tools/cmd/godoc), and the GoDoc website for hosting (https://godoc.org/-/about https://godoc.org/-/about). Using that pair of tools will be a good start.
The advantage of these standardised tools is that it gives most documentation for projects in a given language a common 'look'. Go libraries have one kind of appearance, Python ones another, and so on. This tends to make navigating around much easier.
- forsaken 13y agoHowever, Sphinx & Read the Docs is not just for Python :) http://ericholscher.com/blog/2014/feb/11/sphinx-isnt-just-for-python/ http://ericholscher.com/blog/2014/feb/11/sphinx-isnt-just-fo...