enthought / ets

ets.py is a utility to clone and manage various Enthought Tool Suite packages
http://docs.enthought.com/ets
Other
34 stars 11 forks source link

Automatically run sphinx-apidoc during documentation build #72

Open rahulporuri opened 3 years ago

rahulporuri commented 3 years ago

At the moment, the steps involved in generating documentation for most ETS projects are

This is problematic for the RtD docs setup for ETS projects as at the moment as it simply runs sphinx-build by default. We could potentially use the RtD config file to specify the additional sphinx-apidoc step but it might be easier to take this approach in traits-futures - https://github.com/enthought/traits-futures/pull/348 - where sphinx-apidoc is run as part of sphinx-build.

This also simplifies the documentation build process in general.

Note that because of this issue, none of the ETS projects on RtD which use autogenerated API docs have API documentation.

mdickinson commented 3 years ago

From a quick regex search, the affected repositories look like: apptools, enable, traitsui, pyface and envisage.