Skip to content

Commit

Permalink
docs: rename Developer API to electron-builder
Browse files Browse the repository at this point in the history
  • Loading branch information
develar committed Apr 15, 2017
1 parent edcc71d commit 3347c45
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 25 deletions.
38 changes: 19 additions & 19 deletions docs/Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,19 +104,19 @@ You can use [file macros](#file-macros) in the `from` and `to` fields as well.
* [`.BuildResult`](#BuildResult)
* [`.CliOptions`](#CliOptions) ⇐ <code>[PublishOptions](electron-publish#PublishOptions)</code>
* [`.Config`](#Config) ⇐ <code>[PlatformSpecificBuildOptions](electron-builder-core#PlatformSpecificBuildOptions)</code>
* [`.DebOptions`](#DebOptions) ⇐ <code>[LinuxTargetSpecificOptions](Developer-API#LinuxTargetSpecificOptions)</code>
* [`.DebOptions`](#DebOptions) ⇐ <code>[LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)</code>
* [`.DmgContent`](#DmgContent)
* [`.DmgOptions`](#DmgOptions) ⇐ <code>[TargetSpecificOptions](electron-builder-core#TargetSpecificOptions)</code>
* [`.DmgWindow`](#DmgWindow)
* [`.LinuxBuildOptions`](#LinuxBuildOptions) ⇐ <code>[CommonLinuxOptions](Developer-API#CommonLinuxOptions)</code>
* [`.LinuxBuildOptions`](#LinuxBuildOptions) ⇐ <code>[CommonLinuxOptions](electron-builder#CommonLinuxOptions)</code>
* [`.MacOptions`](#MacOptions) ⇐ <code>[PlatformSpecificBuildOptions](electron-builder-core#PlatformSpecificBuildOptions)</code>
* [`.MasBuildOptions`](#MasBuildOptions) ⇐ <code>[MacOptions](#MacOptions)</code>
* [`.Metadata`](#Metadata)
* [`.NsisOptions`](#NsisOptions) ⇐ <code>[TargetSpecificOptions](electron-builder-core#TargetSpecificOptions)</code>
* [`.NsisWebOptions`](#NsisWebOptions) ⇐ <code>[NsisOptions](#NsisOptions)</code>
* [`.PackagerOptions`](#PackagerOptions)
* [`.PkgOptions`](#PkgOptions) ⇐ <code>[TargetSpecificOptions](electron-builder-core#TargetSpecificOptions)</code>
* [`.PortableOptions`](#PortableOptions) ⇐ <code>[CommonNsisOptions](Developer-API#CommonNsisOptions)</code>
* [`.PortableOptions`](#PortableOptions) ⇐ <code>[CommonNsisOptions](electron-builder#CommonNsisOptions)</code>
* [`.SnapOptions`](#SnapOptions) ⇐ <code>[LinuxBuildOptions](#LinuxBuildOptions)</code>
* [`.SquirrelWindowsOptions`](#SquirrelWindowsOptions) ⇐ <code>[WinBuildOptions](#WinBuildOptions)</code>
* [`.WinBuildOptions`](#WinBuildOptions) ⇐ <code>[PlatformSpecificBuildOptions](electron-builder-core#PlatformSpecificBuildOptions)</code>
Expand All @@ -134,7 +134,7 @@ You can use [file macros](#file-macros) in the `from` and `to` fields as well.
| Name | Type |
| --- | --- |
| **appOutDir**| <code>string</code> |
| **packager**| <code>[PlatformPackager](Developer-API#PlatformPackager)&lt;any&gt;</code> |
| **packager**| <code>[PlatformPackager](electron-builder#PlatformPackager)&lt;any&gt;</code> |
| **electronPlatformName**| <code>string</code> |
| **arch**| <code>[Arch](electron-builder-core#Arch)</code> |
| **targets**| <code>Array&lt;[Target](electron-builder-core#Target)&gt;</code> |
Expand Down Expand Up @@ -164,7 +164,7 @@ AppX Options ([appx](#Config-appx)).

| Name | Type |
| --- | --- |
| **packager**| <code>[PlatformPackager](Developer-API#PlatformPackager)&lt;any&gt;</code> |
| **packager**| <code>[PlatformPackager](electron-builder#PlatformPackager)&lt;any&gt;</code> |
| target| <code>[Target](electron-builder-core#Target)</code> \| <code>null</code> |
| arch| <code>[Arch](electron-builder-core#Arch)</code> \| <code>null</code> |
| file| <code>string</code> |
Expand All @@ -189,7 +189,7 @@ AppX Options ([appx](#Config-appx)).
| **electronVersion**| <code>string</code> |
| muonVersion| <code>string</code> \| <code>null</code> |
| **isTwoPackageJsonProjectLayoutUsed**| <code>boolean</code> |
| **appInfo**| <code>[AppInfo](Developer-API#AppInfo)</code> |
| **appInfo**| <code>[AppInfo](electron-builder#AppInfo)</code> |
| **tempDirManager**| <code>[TmpDir](electron-builder-util#TmpDir)</code> |
| **repositoryInfo**| <code>Promise&lt; \| [SourceRepositoryInfo](electron-builder-core#SourceRepositoryInfo)&gt;</code> |
| **isPrepackedAppAsar**| <code>boolean</code> |
Expand Down Expand Up @@ -284,20 +284,20 @@ Configuration Options
| linux| <code>[LinuxBuildOptions](#LinuxBuildOptions)</code> \| <code>null</code> | <a name="Config-linux"></a> |
| deb| <code>[DebOptions](#DebOptions)</code> \| <code>null</code> | <a name="Config-deb"></a> |
| snap| <code>[SnapOptions](#SnapOptions)</code> \| <code>null</code> | <a name="Config-snap"></a> |
| appimage| <code>[LinuxTargetSpecificOptions](Developer-API#LinuxTargetSpecificOptions)</code> \| <code>null</code> | <a name="Config-appimage"></a> |
| pacman| <code>[LinuxTargetSpecificOptions](Developer-API#LinuxTargetSpecificOptions)</code> \| <code>null</code> | <a name="Config-pacman"></a> |
| rpm| <code>[LinuxTargetSpecificOptions](Developer-API#LinuxTargetSpecificOptions)</code> \| <code>null</code> | <a name="Config-rpm"></a> |
| freebsd| <code>[LinuxTargetSpecificOptions](Developer-API#LinuxTargetSpecificOptions)</code> \| <code>null</code> | <a name="Config-freebsd"></a> |
| p5p| <code>[LinuxTargetSpecificOptions](Developer-API#LinuxTargetSpecificOptions)</code> \| <code>null</code> | <a name="Config-p5p"></a> |
| apk| <code>[LinuxTargetSpecificOptions](Developer-API#LinuxTargetSpecificOptions)</code> \| <code>null</code> | <a name="Config-apk"></a> |
| appimage| <code>[LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)</code> \| <code>null</code> | <a name="Config-appimage"></a> |
| pacman| <code>[LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)</code> \| <code>null</code> | <a name="Config-pacman"></a> |
| rpm| <code>[LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)</code> \| <code>null</code> | <a name="Config-rpm"></a> |
| freebsd| <code>[LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)</code> \| <code>null</code> | <a name="Config-freebsd"></a> |
| p5p| <code>[LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)</code> \| <code>null</code> | <a name="Config-p5p"></a> |
| apk| <code>[LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)</code> \| <code>null</code> | <a name="Config-apk"></a> |

<a name="DebOptions"></a>

### `DebOptions` ⇐ <code>[LinuxTargetSpecificOptions](Developer-API#LinuxTargetSpecificOptions)</code>
### `DebOptions` ⇐ <code>[LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)</code>
Debian Package Specific Options

**Kind**: interface of <code>[electron-builder](#module_electron-builder)</code>
**Extends**: <code>[LinuxTargetSpecificOptions](Developer-API#LinuxTargetSpecificOptions)</code>
**Extends**: <code>[LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)</code>
**Properties**

| Name | Type | Description |
Expand Down Expand Up @@ -375,11 +375,11 @@ DMG Windows Position and Size

<a name="LinuxBuildOptions"></a>

### `LinuxBuildOptions` ⇐ <code>[CommonLinuxOptions](Developer-API#CommonLinuxOptions)</code>
### `LinuxBuildOptions` ⇐ <code>[CommonLinuxOptions](electron-builder#CommonLinuxOptions)</code>
Linux Options

**Kind**: interface of <code>[electron-builder](#module_electron-builder)</code>
**Extends**: <code>[CommonLinuxOptions](Developer-API#CommonLinuxOptions)</code>
**Extends**: <code>[CommonLinuxOptions](electron-builder#CommonLinuxOptions)</code>
**Properties**

| Name | Type | Description |
Expand Down Expand Up @@ -542,11 +542,11 @@ macOS Product Archive Options ([pkg](#Config-pkg)).

<a name="PortableOptions"></a>

### `PortableOptions` ⇐ <code>[CommonNsisOptions](Developer-API#CommonNsisOptions)</code>
### `PortableOptions` ⇐ <code>[CommonNsisOptions](electron-builder#CommonNsisOptions)</code>
Portable Specific Options ([portable](#Config-portable)).

**Kind**: interface of <code>[electron-builder](#module_electron-builder)</code>
**Extends**: <code>[CommonNsisOptions](Developer-API#CommonNsisOptions)</code>
**Extends**: <code>[CommonNsisOptions](electron-builder#CommonNsisOptions)</code>
**Properties**

| Name | Type | Description |
Expand Down Expand Up @@ -632,7 +632,7 @@ Windows Specific Options ([win](#Config-win)).
| **electronVersion**| <code>string</code> |
| muonVersion| <code>string</code> \| <code>null</code> |
| eventEmitter = <code>new EventEmitter()</code>| <code>internal:EventEmitter</code> |
| **appInfo**| <code>[AppInfo](Developer-API#AppInfo)</code> |
| **appInfo**| <code>[AppInfo](electron-builder#AppInfo)</code> |
| tempDirManager = <code>new TmpDir()</code>| <code>[TmpDir](electron-builder-util#TmpDir)</code> |
| prepackaged| <code>string</code> \| <code>null</code> |

Expand Down
2 changes: 1 addition & 1 deletion docs/_Sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

**Programmatic API**

* [[Developer API]]
* [[electron-builder]]
* [[electron-builder-core]]
* [[electron-builder-util]]
* [[electron-builder-http]]
Expand Down
5 changes: 5 additions & 0 deletions docs/api/Developer API.md → docs/api/electron-builder.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
Developer API only. See [[Options]] for user documentation.

<!-- do not edit. start of generated block -->
## Modules

<dl>
Expand Down Expand Up @@ -2800,3 +2803,5 @@
| additionalArgs | <code>Array&lt;string&gt;</code> |
| buildFromSource | <code>boolean</code> |


<!-- end of generated block -->
8 changes: 3 additions & 5 deletions packages/jsdoc2md.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,10 @@ async function main() {
"!updater/electron-updater-out-AppUpdater.js",
], {cwd: source})

const customFiles = new Set(coreFiles.concat(httpFiles).concat(utilFiles).concat(publishOptionsFiles).concat(publishFiles).concat(updaterFiles))

const developerFiles = (await globby([
"**/*.js",
"builder/**/*.js",
], {cwd: source}))
.filter(it => !userFiles.includes(it) && !appUpdateFiles.includes(it) && !customFiles.has(it))
.filter(it => !userFiles.includes(it))

const partialDir = path.join(__dirname, "..", "jsdoc")
const partials = (await globby(["*.hbs"], {cwd: partialDir})).map(it => path.resolve(partialDir, it))
Expand All @@ -63,7 +61,7 @@ async function main() {
{page: "Options.md", pageUrl: "Options", mainHeader: "API", files: userFiles},
{page: "Auto Update.md", pageUrl: "Auto-Update", mainHeader: "API", files: appUpdateFiles},
{page: "Publishing Artifacts.md", pageUrl: "Publishing-Artifacts", mainHeader: "API", files: publishOptionsFiles},
{page: "api/Developer API.md", pageUrl: "Developer-API", files: developerFiles},
{page: "api/electron-builder.md", pageUrl: "electron-builder", files: developerFiles},
{page: "api/electron-builder-util.md", pageUrl: "electron-builder-util", files: utilFiles},
{page: "api/electron-builder-core.md", pageUrl: "electron-builder-core", files: coreFiles},
{page: "api/electron-builder-http.md", pageUrl: "electron-builder-http", files: httpFiles},
Expand Down

0 comments on commit 3347c45

Please sign in to comment.