twisted / pydoctor

This is pydoctor, an API documentation generator that works by static analysis.
https://pydoctor.readthedocs.io
Other
189 stars 50 forks source link

Stop linking to old epydoc site (or just for archive purposes) #347

Open tristanlatr opened 3 years ago

tristanlatr commented 3 years ago

We are facing a logistical issue of where and how to document our documentation format...

Linking to epydoc's old site does not make sens anymore I think since we are now maintaining the reference implementation for Epydoc docstring format parsing. And not everything works the same way epydoc was.

I think the "epytext demo site" should be converted to references documentation just as the epydoc website, but updated for pydoctor. This would also reduce documentation duplication and confusion for users.

For RST, it still makes sens to link to docutils documenation. The references documentation (the future RST "demo site") would contain only main features + extra feature pydoctor ads on top of RST like consolidated fields.

mthuurne commented 3 years ago

I agree that it would be better to document epytext as part of pydoctor's documentation. Until we have that, a link to the original documentation is still better than nothing.

adiroiban commented 3 years ago

Well, the epytext demo, I have created it as a "demo" and not as "documentation".

But I feel find the old epydoc documentation useful.

To close this ticket the demo code should be refactored to serve as self-demonstrating documentation.