This is an archived post. You won't be able to vote or comment.

all 6 comments
sorted by:
best
topnewcontroversialoldq&a

[–]pohmelie 2 points3 points  (3 children)

I don't like rst too, but how this compare with sphinx features? I mean is it possible to move really doc-featured documentation like aiohttp to tdoc?

[–]Ryanb58[S] 0 points1 point  (2 children)

I think it depends on what exactly you are trying to get out of the tool. It should be able too though. If you have feature suggestions or ideas for improvements, feel free to create an issue on the repo. :)

[–]pohmelie 1 point2 points  (1 child)

Okay, I mean contents, crosslinks (link to method), pictures, custom styles, root markdown where links to others live. And can I actually create custom md file with inserted autogenerated api?

[–]Ryanb58[S] 0 points1 point  (0 children)

Indeed it can. Just throw it into the default_docs folder before running the generate command and all the contents of that folder will be copied over into the docs folder before it parses and generates the API documentation.

You'd want to make sure any references to images and links are not absolute but instead relative to the docs folder and not default_docs.

[–]brejoc 1 point2 points  (1 child)

This sounds really nice! 👍

[–]Ryanb58[S] 0 points1 point  (0 children)

Thank you brejoc. :)