search

berkerpeksag / astor

Python AST read/write
https://pypi.org/project/astor/
BSD 3-Clause "New" or "Revised" License
810 stars 102 forks source link

Dual docs -- issue #63 #64

Closed pmaupin closed 7 years ago

pmaupin commented 7 years ago

Make docs work at both github and rtfm.

berkerpeksag commented 7 years ago

This is the case for basically all Sphinx/reST projects on GitHub. I don't think we should clutter the docs for GitHub.

pmaupin commented 7 years ago

This is the case for basically all Sphinx/reST projects

Yeah, it's the case because of the incompatible docutils usage for Sphinx and github. I submitted a patch to the github folks two years ago that was only merged last month, so this was impossible to fix until last month. It's possible now...

I don't think we should clutter the docs for GitHub.

If you feel strongly about it, we won't clutter them. But the clutter is only in the source file; it doesn't show up in the doc at rtfd. I understand that all the other projects have the same problem, but now we have a possibility for a fix, so I'd prefer to at least display the note at the top that you're not seeing everything if you're looking at it on github.