undefined | Better HN

0 pointsNagyman4y ago0 comments

Django has some of my favourite docs, organized incredibly well:

* Tutorials * Topic guides * Reference guides * How-to guides

https://docs.djangoproject.com/en/4.0/#how-the-documentation...

0 comments

Sphinx-based docs are usually excellent due to how easily it lets you flow between tutorials and references.

Sphinx has a nice facility for blending "Javadoc" style documentation with discursive explanations which is used to great effect in the Python docs, but used that way it doesn't automatically generate all of the automatically generatable documentation the way Javadoc does so often you end up with lots of content missing.

j / k navigate · click thread line to collapse

0 pointsNagyman4y ago0 comments

Django has some of my favourite docs, organized incredibly well:

* Tutorials * Topic guides * Reference guides * How-to guides

https://docs.djangoproject.com/en/4.0/#how-the-documentation...

0 comments

Starlevel0014y ago

Sphinx-based docs are usually excellent due to how easily it lets you flow between tutorials and references.

PaulHoule4y ago

j / k navigate · click thread line to collapse