documentationjs / documentationjs/documentation

can't generate proper clean docs

Open
#1,351 7 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

I am trying using the following command: `documentation build ./packages/* -f html -o docs --shallow`

It generates some docs that looks quite weird and it takes quite some time to generate doc. I would like to ignore all the dependencies and only generate doc from the main files. Wondering if the command I am running is right?

For some reason if I remove `--shallow` from the command it complains about not able to find x module hence I added `--shallow`

The folder project structure looks like below:

```
/packages
/package1
/node_modules
/src
index.js
utils.js
/package.json
/package2
/node_modules
/src
index.js
utils.js
package.json
```

I use version **13.1.0**

Running thru CLI

Thank you,

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.