Hello togehter,
I am not sure this is the right place for pydoctor related discussions.
The topic are pydoctor's different supported markup languages [1].
The question seems simple and maybe you can put it to the FAQ [2] of
pydoctor.
Which of the markup languages would you recommend for a new pydoctor
user?
I assume that you use "epydoc" for Twisted, right? But I also assume
that you use it because of historical reasons because pydoctor was born
out of epydoc, right?
I know a bit Google and numpy style from sphinx. I also know Doxygen
"style". But I haven't used one of them long enough to make a decision.
I would say a docu style should...
- be readable in source code
- fit to Python concepts
- support markup (bold text, code blocks, ...)
- less complex for newbies, in the meaning of not to many
options/possibilities
So what is your opinion in that?
Kind
Christian
[1] -- <https://github.com/twisted/pydoctor#markup>
[2] -- <https://pydoctor.readthedocs.io/en/latest/faq.html>
_______________________________________________
Twisted mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/twisted.python.org/
Message archived at
https://mail.python.org/archives/list/[email protected]/message/6LCHY6W2ZOMK2FGO5HZSYIZUQ6DAJYY4/
Code of Conduct: https://twisted.org/conduct
