Why Epydoc?

Asked by oglop

Coudl you please post the documentation of something more readable like https://readthedocs.org/ ?
I think that epydoc is pretty outdated and messy.

Thank you.

Question information

Language:
English Edit question
Status:
Answered
For:
Duplicity Edit question
Assignee:
No assignee Edit question
Last query:
Last reply:
Revision history for this message
Kenneth Loafman (kenneth-loafman) said :
#1

It's also not up-to-date by a couple of years.

Been looking at readthedocs.org, sorta, but we still need something good to
document the code itself.

On Thu, Aug 18, 2016 at 8:02 AM, oglop <<email address hidden>
> wrote:

> New question #352569 on Duplicity:
> https://answers.launchpad.net/duplicity/+question/352569
>
> Coudl you please post the documentation of something more readable like
> https://readthedocs.org/ ?
> I think that epydoc is pretty outdated and messy.
>
> Thank you.
>
> --
> You received this question notification because your team duplicity-team
> is an answer contact for Duplicity.
>
> _______________________________________________
> Mailing list: https://launchpad.net/~duplicity-team
> Post to : <email address hidden>
> Unsubscribe : https://launchpad.net/~duplicity-team
> More help : https://help.launchpad.net/ListHelp
>

Revision history for this message
oglop (1oglop1) said :
#2

Then why not sphinx?

http://docs.python-guide.org/en/latest/writing/documentation/

I'm not the best programmer and even worse reader, but is there anything I can help you with according to documentation?
Because I rather read source code than epydoc and maybe I can learn something also.

Revision history for this message
Kenneth Loafman (kenneth-loafman) said :
#3

Started making the move to readthedocs & sphinx last weekend. The first pass is at duplicity.readthedocs.io. Not a great start since it only seems to pick up the docstrings, but it does look a bit better than epydoc.

Can you help with this problem?

Provide an answer of your own, or ask oglop for more information if necessary.

To post a message you must log in.