Recurse by default
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 290
- Forks
- 80
- PR merge metrics
- No merged PRs in 30d
Description
It might be nice to find JS files deeper than at the root of the source directory. To so do, pass -r to jsdoc. However, that also searches within any node_modules dir, which is bad, because that's huge and irrelevant. We can exclude node_modules using a jsdoc config file.
Thus, the way to go about this is probably to include a jsdoc conf file inside sphinx-js and point to it. Set up the exclusion and say recurse:true within it.
People who want to provide their own jsdoc config files should start with a copy of ours and can control their own recursion preferences.
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.
Research direction
Start by locating where sphinx-js invokes JSDoc and where project configuration files are packaged or passed through. Add the shared JSDoc configuration with recursion enabled and node_modules excluded, then verify that nested JS files are found without traversing node_modules and that users can copy the configuration to override recursion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100