partial files

[R3l4x3]

Is there a way to parse partial files too? At the moment my doc only include 1 .scss file with one variable but in this file you find this variable and 2 @import. But these files are ignored.

[pascalduez]

SassDoc will parse all .scss files that are childs of your source folder: src. Partials files included.
Could you provide a bit more insights to help us help you ?

[R3l4x3]

ok, here a screen of our file structure:

The content of styles.scss:

$sprites-layout: smart;
//@import "../sprites/*.png";

@import "framework";
@import "project";

_framework.scss & _project.scss include more @import

And this is the SassDoc after I used the following command sassdoc . ../test/ -c .sassdocrc --verbose

Do you need more information?

edit: my .sassdocrc

{
"package": {
    "title": "Test",
    "version": "0.1",
},
"theme": "default",
}

[pascalduez]

SassDoc will not care about @import. But since _framework.scss _project.scss are on the same level as styles.scss they should be parsed too. If I understand well, the CWD your in is css ?
Do those files have SassDoc comments in ?

[R3l4x3]

Oh, maybe I interpret the SassDoc slightly wrong. I thought I could pass a comment on top of every file to describe a file and its usage. If I get the SassDoc right I can describe variables, mixins and functions "only"?
Yes, the CWD is css.

[pascalduez]

You have file level annotations, that will apply to every items in the file (unless overridden).
http://sassdoc.com/file-level-annotations
But this means having items in the file...

SassDoc supports variables, placeholders, functions, mixins.

Items won't be organized by file, but rather by type.
You have to ability to define groups instead. And choose an appropriate name/title for them.

[pascalduez]

So if you want to keep your docs structure similar to your files, you have to use a mixture of file level annotations and groups:

_framework.scss

////
//// @group framework
////

/// Whatsoever
@function foo() {}

_project.scss

////
//// @group project
////

/// Whatever
@function bar() {}

in your .sassdocrc:

"groups": {
  "undefined": "General",
  "framework": "Framework related stuff title",
  "project": "Project related stuff title"
}

[R3l4x3]

Ok, thank you for your help, @pascalduez !

But it seems that I've a new problem or something I don't get either:

This is a partial file for testing purposes

/**
 * font.scss
 *
 * @author   Sebastian
 **/


$test: 12 !default;

/**
 * font-size
 *
 * @author   Sebastian
 */
@mixin font-size($px: $test) {
    font-size: $px + px;
    font-size: ($px / 10) + rem;
}

This is the SassDoc CLI Output:

$ sassdoc default/skin/css default/skin/test/ -c default/skin/css/.sassdocrc --verbose
[?] Destination folder will be wiped out. Are you sure you want to proceed? [y/N] y
[2015-01-07 11:48:08] Folder `default/skin/test/` successfully generated.
[2015-01-07 11:48:08] File `default/skin/css/.sassdocrc` is not a `.scss` file. Omitted.
[2015-01-07 11:48:08] File `default/skin/css/styles.css` is not a `.scss` file. Omitted.
[2015-01-07 11:48:08] Folder `default/skin/css` successfully parsed.
[2015-01-07 11:48:08] Theme `default` successfully rendered.
[2015-01-07 11:48:08] Process over. Everything okay!

And this is my Doc-Output:

It strikes me that there:

• is no parameter in the mixin brackets
• there is no variable $test

Where is my mistake?

[KittyGiraudel]

You have to declare your parameters with @param.

Try removing empty lines between the comment and your variable declaration.

[pascalduez]

$test: 12 !default;

Needs to have a comment to appear in the docs

/**
 * A variable
 */
$test: 12 !default;

[R3l4x3]

Okay, I think I get it now. Thank you guys for your help!