Fix traitsdoc setup and compliance with py3 #341

Merged
merged 6 commits into from Apr 20, 2016

Conversation

Projects
None yet
2 participants
@kitchoi
Member

kitchoi commented Apr 11, 2016

Traits properties should show in the API documentation with this PR. And doc build should work on Python3.

Although previously changes in #293 led to successful doc build, it in fact did not setup sphinx to use traitsdoc.get_doc_object and traitsdoc.SphinxTraitsDoc (my fault!). This PR fixes this problem.

Partial fix is made to compiler_unparse according changes in the API of ast; enough for the current doc build. In the future we may consider using customised comment syntax for documenting traits (e.g. https://github.com/enthought/trait-documenter) instead of printing the code for the traits definition, therefore removing the need for unparsing AST back to code.

Tested on OS X + Python3 + Sphinx 1.4, and Ubuntu + Python2.7 + Sphinx1.3.5

@itziakos : does this fix #228 too?

@prabhuramachandran

This comment has been minimized.

Show comment
Hide comment
@prabhuramachandran

prabhuramachandran Apr 20, 2016

Member

Thanks, this is awesome! Merging.

Member

prabhuramachandran commented Apr 20, 2016

Thanks, this is awesome! Merging.

@prabhuramachandran prabhuramachandran merged commit 453f844 into master Apr 20, 2016

5 checks passed

codecov/project 45.37% (target 40.00%)
Details
continuous-integration/appveyor/branch AppVeyor build succeeded
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@prabhuramachandran prabhuramachandran deleted the fix-sphinx-traitsdoc-py3 branch Apr 20, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment