question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Does not seem to generate the Docs folder?

See original GitHub issue

I set this up as per your instructions and when I run it says that it has “Documented 13 files!”, but no actual folder is created with the documentation. I have setup the config file as follows:

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc","closure"]
    },
    "source": {
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "opts": {
        "destination": "./docs/"
    },
    "plugins": [],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
    }
}

My gulp file is this:

var gulp          = require('gulp');
var jsdoc         = require('gulp-jsdoc3');
var config        = require('../config');
var jsdocConfig   = require('../../jsdocConfig');

gulp.task('docs', function (cb) {
    gulp.src('./app/src/modules/**/*.js', {read: false})
        .pipe(jsdoc(jsdocConfig, cb));
});

Issue Analytics

  • State:closed
  • Created 8 years ago
  • Comments:6 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
Quirksmodecommented, Jan 3, 2016

Hi,

Thanks for getting back to me, I removed “excludePattern”: “(^|/|\)_” and it seemed to work.

0reactions
raphaelparentcommented, Aug 16, 2016

I went ahead and did a node script that generates it with the CLI, because that worked. Unfortunately I won’t have time do build a small example of the problem.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Create a folder in a document library - Microsoft Support
On the menu bar, select + New, and then select Folder. If you don't have folders as an option on the + New...
Read more >
Auto generate sidebar according to the docs folder structure
For me, it seems to be redundant to manage both the sidebars file and the docs folder structure, since the sidebars can be...
Read more >
Can't open a Google file or folder - Android
To sign in to another account: On your Android device, open the app for Google Drive, Docs, Sheets, or Slides. At the top...
Read more >
Google Docs: Managing Your Files - GCFGlobal
To create a folder: · From Google Drive, click the New button, then select Folder from the drop-down menu. Creating a new folder....
Read more >
Organize files in folders on Mac - Apple Support
As you create documents, install apps, and do other work, add new folders to ... option appears only if one of the folders...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found