Move docs list to separate module
Summary: We want to pull RN API docs into exponent. So moving them into a module will be useful since we don't want to keep a duplicate list. Run `npm start` in the `website` folder and see it still generates docs. cc brentvatne Closes https://github.com/facebook/react-native/pull/11712 Differential Revision: D4380320 fbshipit-source-id: 103e5deecdbe9aa1a4690496bf954b5cdd6be097
This commit is contained in:
Satyajit Sahoo
Facebook Github Bot
parent
21ba956560
commit
21c4705add
|
|
@ -0,0 +1,107 @@
|
|||
/**
|
||||
* Copyright (c) 2015-present, Facebook, Inc.
|
||||
* All rights reserved.
|
||||
*
|
||||
* This source code is licensed under the BSD-style license found in the
|
||||
* LICENSE file in the root directory of this source tree. An additional grant
|
||||
* of patent rights can be found in the PATENTS file in the same directory.
|
||||
*/
|
||||
|
||||
'use strict';
|
||||
|
||||
const components = [
|
||||
'../Libraries/Components/ActivityIndicator/ActivityIndicator.js',
|
||||
'../Libraries/Components/Button.js',
|
||||
'../Libraries/Components/DatePicker/DatePickerIOS.ios.js',
|
||||
'../Libraries/Components/DrawerAndroid/DrawerLayoutAndroid.android.js',
|
||||
'../Libraries/Image/Image.ios.js',
|
||||
'../Libraries/Components/Keyboard/KeyboardAvoidingView.js',
|
||||
'../Libraries/CustomComponents/ListView/ListView.js',
|
||||
'../Libraries/Components/MapView/MapView.js',
|
||||
'../Libraries/Modal/Modal.js',
|
||||
'../Libraries/CustomComponents/Navigator/Navigator.js',
|
||||
'../Libraries/Components/Navigation/NavigatorIOS.ios.js',
|
||||
'../Libraries/Components/Picker/Picker.js',
|
||||
'../Libraries/Components/Picker/PickerIOS.ios.js',
|
||||
'../Libraries/Components/ProgressBarAndroid/ProgressBarAndroid.android.js',
|
||||
'../Libraries/Components/ProgressViewIOS/ProgressViewIOS.ios.js',
|
||||
'../Libraries/Components/RefreshControl/RefreshControl.js',
|
||||
'../Libraries/Components/ScrollView/ScrollView.js',
|
||||
'../Libraries/Components/SegmentedControlIOS/SegmentedControlIOS.ios.js',
|
||||
'../Libraries/Components/Slider/Slider.js',
|
||||
'../Libraries/RCTTest/SnapshotViewIOS.ios.js',
|
||||
'../Libraries/Components/StatusBar/StatusBar.js',
|
||||
'../Libraries/Components/Switch/Switch.js',
|
||||
'../Libraries/Components/TabBarIOS/TabBarIOS.ios.js',
|
||||
'../Libraries/Components/TabBarIOS/TabBarItemIOS.ios.js',
|
||||
'../Libraries/Text/Text.js',
|
||||
'../Libraries/Components/TextInput/TextInput.js',
|
||||
'../Libraries/Components/ToolbarAndroid/ToolbarAndroid.android.js',
|
||||
'../Libraries/Components/Touchable/TouchableHighlight.js',
|
||||
'../Libraries/Components/Touchable/TouchableNativeFeedback.android.js',
|
||||
'../Libraries/Components/Touchable/TouchableOpacity.js',
|
||||
'../Libraries/Components/Touchable/TouchableWithoutFeedback.js',
|
||||
'../Libraries/Components/View/View.js',
|
||||
'../Libraries/Components/ViewPager/ViewPagerAndroid.android.js',
|
||||
'../Libraries/Components/WebView/WebView.ios.js',
|
||||
];
|
||||
|
||||
const apis = [
|
||||
'../Libraries/ActionSheetIOS/ActionSheetIOS.js',
|
||||
'../Libraries/AdSupport/AdSupportIOS.js',
|
||||
'../Libraries/Alert/Alert.js',
|
||||
'../Libraries/Alert/AlertIOS.js',
|
||||
'../Libraries/Animated/src/AnimatedImplementation.js',
|
||||
'../Libraries/ReactNative/AppRegistry.js',
|
||||
'../Libraries/AppState/AppState.js',
|
||||
'../Libraries/Storage/AsyncStorage.js',
|
||||
'../Libraries/Utilities/BackAndroid.android.js',
|
||||
'../Libraries/CameraRoll/CameraRoll.js',
|
||||
'../Libraries/Components/Clipboard/Clipboard.js',
|
||||
'../Libraries/Components/DatePickerAndroid/DatePickerAndroid.android.js',
|
||||
'../Libraries/Utilities/Dimensions.js',
|
||||
'../Libraries/Animated/src/Easing.js',
|
||||
'../Libraries/Geolocation/Geolocation.js',
|
||||
'../Libraries/Image/ImageEditor.js',
|
||||
'../Libraries/CameraRoll/ImagePickerIOS.js',
|
||||
'../Libraries/Image/ImageStore.js',
|
||||
'../Libraries/Interaction/InteractionManager.js',
|
||||
'../Libraries/Components/Keyboard/Keyboard.js',
|
||||
'../Libraries/LayoutAnimation/LayoutAnimation.js',
|
||||
'../Libraries/Linking/Linking.js',
|
||||
'../Libraries/CustomComponents/ListView/ListViewDataSource.js',
|
||||
'../Libraries/Renderer/src/renderers/native/NativeMethodsMixin.js',
|
||||
'../Libraries/Network/NetInfo.js',
|
||||
'../Libraries/Interaction/PanResponder.js',
|
||||
'../Libraries/PermissionsAndroid/PermissionsAndroid.js',
|
||||
'../Libraries/Utilities/PixelRatio.js',
|
||||
'../Libraries/PushNotificationIOS/PushNotificationIOS.js',
|
||||
'../Libraries/Settings/Settings.ios.js',
|
||||
'../Libraries/Share/Share.js',
|
||||
'../Libraries/Components/StatusBar/StatusBarIOS.ios.js',
|
||||
'../Libraries/StyleSheet/StyleSheet.js',
|
||||
'../Libraries/Performance/Systrace.js',
|
||||
'../Libraries/Components/TimePickerAndroid/TimePickerAndroid.android.js',
|
||||
'../Libraries/Components/ToastAndroid/ToastAndroid.android.js',
|
||||
'../Libraries/Vibration/Vibration.js',
|
||||
'../Libraries/Vibration/VibrationIOS.ios.js',
|
||||
];
|
||||
|
||||
const stylesWithPermalink = [
|
||||
'../Libraries/StyleSheet/LayoutPropTypes.js',
|
||||
'../Libraries/StyleSheet/TransformPropTypes.js',
|
||||
'../Libraries/Components/View/ShadowPropTypesIOS.js',
|
||||
];
|
||||
|
||||
const stylesForEmbed = [
|
||||
'../Libraries/Components/View/ViewStylePropTypes.js',
|
||||
'../Libraries/Text/TextStylePropTypes.js',
|
||||
'../Libraries/Image/ImageStylePropTypes.js',
|
||||
];
|
||||
|
||||
module.exports = {
|
||||
components,
|
||||
apis,
|
||||
stylesWithPermalink,
|
||||
stylesForEmbed,
|
||||
};
|
||||
|
|
@ -18,6 +18,7 @@ const jsDocs = require('../jsdocs/jsdocs.js');
|
|||
const jsdocApi = require('jsdoc-api');
|
||||
const path = require('path');
|
||||
const slugify = require('../core/slugify');
|
||||
const docsList = require('./docsList');
|
||||
|
||||
const ANDROID_SUFFIX = 'android';
|
||||
const CROSS_SUFFIX = 'cross';
|
||||
|
|
@ -483,101 +484,11 @@ function renderStyle(filepath) {
|
|||
return componentsToMarkdown('style', json, filepath, componentCount++);
|
||||
}
|
||||
|
||||
const components = [
|
||||
'../Libraries/Components/ActivityIndicator/ActivityIndicator.js',
|
||||
'../Libraries/Components/Button.js',
|
||||
'../Libraries/Components/DatePicker/DatePickerIOS.ios.js',
|
||||
'../Libraries/Components/DrawerAndroid/DrawerLayoutAndroid.android.js',
|
||||
'../Libraries/Image/Image.ios.js',
|
||||
'../Libraries/Components/Keyboard/KeyboardAvoidingView.js',
|
||||
'../Libraries/CustomComponents/ListView/ListView.js',
|
||||
'../Libraries/Components/MapView/MapView.js',
|
||||
'../Libraries/Modal/Modal.js',
|
||||
'../Libraries/CustomComponents/Navigator/Navigator.js',
|
||||
'../Libraries/Components/Navigation/NavigatorIOS.ios.js',
|
||||
'../Libraries/Components/Picker/Picker.js',
|
||||
'../Libraries/Components/Picker/PickerIOS.ios.js',
|
||||
'../Libraries/Components/ProgressBarAndroid/ProgressBarAndroid.android.js',
|
||||
'../Libraries/Components/ProgressViewIOS/ProgressViewIOS.ios.js',
|
||||
'../Libraries/Components/RefreshControl/RefreshControl.js',
|
||||
'../Libraries/Components/ScrollView/ScrollView.js',
|
||||
'../Libraries/Components/SegmentedControlIOS/SegmentedControlIOS.ios.js',
|
||||
'../Libraries/Components/Slider/Slider.js',
|
||||
'../Libraries/RCTTest/SnapshotViewIOS.ios.js',
|
||||
'../Libraries/Components/StatusBar/StatusBar.js',
|
||||
'../Libraries/Components/Switch/Switch.js',
|
||||
'../Libraries/Components/TabBarIOS/TabBarIOS.ios.js',
|
||||
'../Libraries/Components/TabBarIOS/TabBarItemIOS.ios.js',
|
||||
'../Libraries/Text/Text.js',
|
||||
'../Libraries/Components/TextInput/TextInput.js',
|
||||
'../Libraries/Components/ToolbarAndroid/ToolbarAndroid.android.js',
|
||||
'../Libraries/Components/Touchable/TouchableHighlight.js',
|
||||
'../Libraries/Components/Touchable/TouchableNativeFeedback.android.js',
|
||||
'../Libraries/Components/Touchable/TouchableOpacity.js',
|
||||
'../Libraries/Components/Touchable/TouchableWithoutFeedback.js',
|
||||
'../Libraries/Components/View/View.js',
|
||||
'../Libraries/Components/ViewPager/ViewPagerAndroid.android.js',
|
||||
'../Libraries/Components/WebView/WebView.ios.js',
|
||||
];
|
||||
const all = docsList.components
|
||||
.concat(docsList.apis)
|
||||
.concat(docsList.stylesWithPermalink);
|
||||
|
||||
const apis = [
|
||||
'../Libraries/ActionSheetIOS/ActionSheetIOS.js',
|
||||
'../Libraries/AdSupport/AdSupportIOS.js',
|
||||
'../Libraries/Alert/Alert.js',
|
||||
'../Libraries/Alert/AlertIOS.js',
|
||||
'../Libraries/Animated/src/AnimatedImplementation.js',
|
||||
'../Libraries/ReactNative/AppRegistry.js',
|
||||
'../Libraries/AppState/AppState.js',
|
||||
'../Libraries/Storage/AsyncStorage.js',
|
||||
'../Libraries/Utilities/BackAndroid.android.js',
|
||||
'../Libraries/CameraRoll/CameraRoll.js',
|
||||
'../Libraries/Components/Clipboard/Clipboard.js',
|
||||
'../Libraries/Components/DatePickerAndroid/DatePickerAndroid.android.js',
|
||||
'../Libraries/Utilities/Dimensions.js',
|
||||
'../Libraries/Animated/src/Easing.js',
|
||||
'../Libraries/Geolocation/Geolocation.js',
|
||||
'../Libraries/Image/ImageEditor.js',
|
||||
'../Libraries/CameraRoll/ImagePickerIOS.js',
|
||||
'../Libraries/Image/ImageStore.js',
|
||||
'../Libraries/Interaction/InteractionManager.js',
|
||||
'../Libraries/Components/Keyboard/Keyboard.js',
|
||||
'../Libraries/LayoutAnimation/LayoutAnimation.js',
|
||||
'../Libraries/Linking/Linking.js',
|
||||
'../Libraries/CustomComponents/ListView/ListViewDataSource.js',
|
||||
'../Libraries/Renderer/src/renderers/native/NativeMethodsMixin.js',
|
||||
'../Libraries/Network/NetInfo.js',
|
||||
'../Libraries/Interaction/PanResponder.js',
|
||||
'../Libraries/PermissionsAndroid/PermissionsAndroid.js',
|
||||
'../Libraries/Utilities/PixelRatio.js',
|
||||
'../Libraries/PushNotificationIOS/PushNotificationIOS.js',
|
||||
'../Libraries/Settings/Settings.ios.js',
|
||||
'../Libraries/Share/Share.js',
|
||||
'../Libraries/Components/StatusBar/StatusBarIOS.ios.js',
|
||||
'../Libraries/StyleSheet/StyleSheet.js',
|
||||
'../Libraries/Performance/Systrace.js',
|
||||
'../Libraries/Components/TimePickerAndroid/TimePickerAndroid.android.js',
|
||||
'../Libraries/Components/ToastAndroid/ToastAndroid.android.js',
|
||||
'../Libraries/Vibration/Vibration.js',
|
||||
'../Libraries/Vibration/VibrationIOS.ios.js',
|
||||
];
|
||||
|
||||
const stylesWithPermalink = [
|
||||
'../Libraries/StyleSheet/LayoutPropTypes.js',
|
||||
'../Libraries/StyleSheet/TransformPropTypes.js',
|
||||
'../Libraries/Components/View/ShadowPropTypesIOS.js',
|
||||
];
|
||||
|
||||
const stylesForEmbed = [
|
||||
'../Libraries/Components/View/ViewStylePropTypes.js',
|
||||
'../Libraries/Text/TextStylePropTypes.js',
|
||||
'../Libraries/Image/ImageStylePropTypes.js',
|
||||
];
|
||||
|
||||
const all = components
|
||||
.concat(apis)
|
||||
.concat(stylesWithPermalink);
|
||||
|
||||
const styleDocs = stylesForEmbed.reduce(function(docs, filepath) {
|
||||
const styleDocs = docsList.stylesForEmbed.reduce(function(docs, filepath) {
|
||||
docs[path.basename(filepath).replace(path.extname(filepath), '')] =
|
||||
docgen.parse(
|
||||
fs.readFileSync(filepath),
|
||||
|
|
@ -595,11 +506,11 @@ const styleDocs = stylesForEmbed.reduce(function(docs, filepath) {
|
|||
function extractDocs() {
|
||||
componentCount = 0;
|
||||
return [].concat(
|
||||
components.map(renderComponent),
|
||||
apis.map((filepath) => {
|
||||
docsList.components.map(renderComponent),
|
||||
docsList.apis.map((filepath) => {
|
||||
return renderAPI(filepath, 'api');
|
||||
}),
|
||||
stylesWithPermalink.map(renderStyle)
|
||||
docsList.stylesWithPermalink.map(renderStyle)
|
||||
);
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue