mirror of
https://github.com/not-kennethreitz/convore.json.git
synced 2026-06-21 15:40:58 +00:00
1 line
2.4 KiB
JSON
1 line
2.4 KiB
JSON
[{"user_id": 141, "stars": [], "topic_id": 9324, "date_created": 1298790719.2166419, "message": "for the last project where i used autodoc, i made sure it was split up so that it generated into small enough and logically grouped docs", "group_id": 81, "id": 216733}, {"user_id": 141, "stars": [], "topic_id": 9324, "date_created": 1298790900.899581, "message": "e.g. each of the modules in http://sixapart.github.com/python-typepad-api/ got their own page, it's not the whole package in one go", "group_id": 81, "id": 216735}, {"user_id": 177, "stars": [{"date_created": 1298791582.3340781, "user_id": 141}], "topic_id": 9324, "date_created": 1298789530.5001819, "message": "So recently I took full advantage of autodoc in one of my projects, but it's starting to make scrolling through things a bit tiresome. Are people here big fans of autodoc? Or would it be just as sane to just document all of it normally in the .rst documents?", "group_id": 81, "id": 216710}, {"user_id": 141, "stars": [], "topic_id": 9324, "date_created": 1298791028.8146739, "message": "plus the \u201ccontent object\u201d classes in typepad.api are even on their own pages, since there were so very, very many of them", "group_id": 81, "id": 216736}, {"user_id": 141, "stars": [], "topic_id": 9324, "date_created": 1298791158.3908961, "message": "that's partly cause they're generated and it was easier to make an .rst file per class though. ideally we would have logically grouped them into topics (blogs, groups, feedsub, etc).", "group_id": 81, "id": 216740}, {"user_id": 141, "stars": [], "topic_id": 9324, "date_created": 1298791548.3583901, "message": "in general i still like autodoc for API reference documentation (as a complement to some narrative documentation), when you use it as a tool in service of that editorial judgment.", "group_id": 81, "id": 216754}, {"user_id": 257, "stars": [{"date_created": 1298819866.195878, "user_id": 4156}, {"date_created": 1299072935.4224761, "user_id": 927}], "topic_id": 9324, "date_created": 1298811628.087642, "message": "I use autodoc for reference only. One autodoc .rst for every module.", "group_id": 81, "id": 217150}, {"user_id": 13814, "stars": [], "topic_id": 9324, "date_created": 1298819574.395606, "message": "Another approach is to use epydoc for the extracted stuff and Sphinx for the rest. Generates two different doc files, but we expose the Sphinx docs to admin users, but not the epydocs and that works out well.", "group_id": 81, "id": 217447}] |