Automatically run sphinx-apidoc during documentation build
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- build-system, documentation
Research direction
Review the documentation build steps described in the issue and compare them with the traits-futures pull request linked there. Determine how sphinx-apidoc can run as part of sphinx-build, then check the affected ETS projects listed in the issue. Done means Read the Docs builds include autogenerated API documentation for the applicable projects without a separate manual step.
Written by the indexing model from the issue text.
Description
At the moment, the steps involved in generating documentation for most ETS projects are
- run sphinx-apidoc to generate the api documetation
- run sphinx-build to build the docs
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.
- apptools
- enable
- envisage
- pyface
- traitsui
- Dominant language
- Python
- Stars
- 33
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from enthought/ets
-
Difficulty 3/5 1-2 days Newbie friendliness 38/100
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100