forked from woocommerce/woocommerce
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3a20e6b
commit 453ca39
Showing
3 changed files
with
14 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,20 @@ | ||
source: ./ | ||
|
||
destination: wc-apidocs | ||
|
||
templateConfig: apigen/theme-woocommerce/config.neon | ||
|
||
# list of scanned file extensions (e.g. php5, phpt...) | ||
extensions: [php] | ||
|
||
# directories and files matching this file mask will not be parsed | ||
source: | ||
- woocommerce.php | ||
- includes | ||
exclude: | ||
- includes/libraries/ | ||
- includes/api/legacy/ | ||
- i18n/ | ||
- node_modules/ | ||
- wc-apidocs/ | ||
- tmp/ | ||
- tests/ | ||
- .sass-cache/ | ||
- apigen/ | ||
|
||
# character set of source files; if you use only one across your files, we recommend you name it | ||
charset: [UTF-8] | ||
|
||
# elements with this name prefix will be considered as the "main project" (the rest will be considered as libraries) | ||
main: WC | ||
|
||
# title of generated documentation | ||
title: WooCommerce 3.0.x Code Reference | ||
|
||
# base url used for sitemap (useful for public doc) | ||
title: WooCommerce Code Reference | ||
baseUrl: https://docs.woocommerce.com/wc-apidocs/ | ||
|
||
# choose ApiGen template theme | ||
templateTheme: default | ||
|
||
# generate documentation for PHP internal classes | ||
php: false | ||
|
||
# generate highlighted source code for elements | ||
sourceCode: true | ||
|
||
# generate tree view of classes, interfaces, traits and exceptions | ||
tree: true | ||
|
||
# generate documentation for deprecated elements | ||
deprecated: true | ||
|
||
# generate list of tasks with @ todo annotation | ||
todo: true | ||
|
||
# add link to ZIP archive of documentation | ||
download: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters