berkerpeksag / astor

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

Update docs/index.rst to work better at github #63

Closed pmaupin closed 7 years ago

pmaupin commented 7 years ago

Unfortunately, the Sphinx guys (ab)used the docutils class:: keyword for Python classes.

That means that the doc looks fine here but the class names are missing here.

A couple of years ago, I submitted an issue and PR to github to be able to support such things. They finally accepted it last month; the result is that you can make a doc that displays nicely under Sphinx, and reasonably at github, and also explains you should view it elsewhere. That is all documented here

So the right answer is to update index.rst accordingly.