Skip to content

Commit c4a2a02

Browse files
MichaelAldrichMichaelAldrich
authored
Merge pull request #51 from nxt-dev/docs_updates
Docs update
2 parents 4c66fd2 + a63d889 commit c4a2a02

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+340
-13261
lines changed

‎build/api_docs.nxt‎

Lines changed: 68 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,128 +1,128 @@
11
{
2-
"version": "1.16",
3-
"alias": "api_docs",
4-
"color": null,
5-
"mute": false,
6-
"solo": false,
2+
"version": "1.17",
3+
"alias": "api_docs",
4+
"color": "#c91781",
5+
"mute": false,
6+
"solo": false,
77
"meta_data": {
88
"positions": {
99
"/build": [
10-
-320.0,
10+
-320.0,
1111
360.0
12-
],
12+
],
13+
"/build/generate_stubs": [
14+
0.0,
15+
0.0
16+
],
1317
"/build_to_user_docs": [
14-
20.0,
18+
20.0,
1519
280.0
16-
],
20+
],
1721
"/deploy": [
18-
-320.0,
22+
-320.0,
1923
280.0
20-
],
24+
],
2125
"/node": [
22-
-180.0,
26+
-180.0,
2327
-60.0
2428
]
25-
},
29+
},
2630
"collapse": {
2731
"/build/cleanup_stubs": false
2832
}
29-
},
33+
},
3034
"nodes": {
3135
"/": {
32-
"child_order": [
33-
"build",
34-
"deploy",
35-
"build_to_user_docs"
36-
],
3736
"attrs": {
3837
"build_folder": {
39-
"type": "raw",
40-
"value": "${file::../docs/api_docs/build}"
41-
},
38+
"type": "raw",
39+
"value": "${path::../docs/build/html}"
40+
},
4241
"module_folder": {
43-
"type": "raw",
42+
"type": "raw",
4443
"value": "${file::../nxt}"
45-
},
44+
},
4645
"stubs_folder": {
47-
"type": "raw",
48-
"value": "${file::../docs/api_docs/source}"
46+
"type": "raw",
47+
"value": "${file::../docs/source}"
4948
}
50-
},
49+
},
5150
"code": [
52-
"import subprocess",
53-
"import os",
51+
"import subprocess",
52+
"import os",
5453
"import shutil"
5554
]
56-
},
55+
},
5756
"/build": {
58-
"start_point": true,
57+
"start_point": true,
5958
"child_order": [
60-
"generate_stubs",
61-
"generate_html",
59+
"generate_stubs",
60+
"generate_html",
6261
"cleanup_stubs"
6362
]
64-
},
63+
},
6564
"/build/cleanup_stubs": {
65+
"enabled": false,
6666
"attrs": {
6767
"stub_keep_files": {
68-
"type": "list",
68+
"type": "list",
6969
"value": "['conf.py', 'index.rst']"
7070
}
71-
},
71+
},
7272
"code": [
73-
"import tempfile",
74-
"",
75-
"relocated_files = []",
76-
"keep_dir = tempfile.gettempdir()",
77-
"for keep_filename in self.stub_keep_files:",
78-
" full_keep_path = os.path.join(self.stubs_folder, keep_filename)",
79-
" temp_path = os.path.join(keep_dir, keep_filename)",
80-
" shutil.move(full_keep_path, keep_dir)",
81-
" relocated_files += [temp_path]",
82-
"",
83-
"shutil.rmtree('${stubs_folder}')",
84-
"os.makedirs('${stubs_folder}')",
85-
"for temp_path in relocated_files:",
73+
"import tempfile",
74+
"",
75+
"relocated_files = []",
76+
"keep_dir = tempfile.gettempdir()",
77+
"for keep_filename in self.stub_keep_files:",
78+
" full_keep_path = os.path.join(self.stubs_folder, keep_filename)",
79+
" temp_path = os.path.join(keep_dir, keep_filename)",
80+
" shutil.move(full_keep_path, keep_dir)",
81+
" relocated_files += [temp_path]",
82+
"",
83+
"shutil.rmtree('${stubs_folder}')",
84+
"os.makedirs('${stubs_folder}')",
85+
"for temp_path in relocated_files:",
8686
" shutil.move(temp_path, '${stubs_folder}')"
8787
]
88-
},
88+
},
8989
"/build/generate_html": {
9090
"code": [
9191
"subprocess.call(['sphinx-build', '-b', 'html', '${stubs_folder}', '${build_folder}'])"
9292
]
93-
},
93+
},
9494
"/build/generate_stubs": {
95+
"enabled": false,
9596
"code": [
9697
"subprocess.call(['sphinx-apidoc', '-e', '-o', '${stubs_folder}', '${module_folder}'])"
9798
]
98-
},
99+
},
99100
"/build_to_user_docs": {
100-
"instance": "/build",
101-
"execute_in": "/deploy",
101+
"instance": "/build",
102+
"execute_in": "/deploy",
102103
"child_order": [
103-
"remove_previous_build",
104-
"generate_stubs",
105-
"generate_html",
104+
"remove_previous_build",
105+
"generate_html",
106106
"cleanup_stubs"
107-
],
107+
],
108108
"attrs": {
109109
"build_folder": {
110-
"value": "${file::../docs/user_docs/docs/api}"
110+
"type": "raw",
111+
"value": "${path::../../nxt-dev.github.io/docs/user_docs/docs/api}"
112+
},
113+
"real_build": {
114+
"type": "raw",
115+
"value": "${file::${build_folder}}"
111116
}
112117
}
113-
},
118+
},
114119
"/build_to_user_docs/remove_previous_build": {
115-
"attrs": {
116-
"build_folder": {
117-
"value": "${path::../docs/user_docs/docs/api}"
118-
}
119-
},
120120
"code": [
121-
"if os.path.exists('${build_folder}'):",
122-
" shutil.rmtree('${build_folder}')",
121+
"if os.path.exists('${build_folder}'):",
122+
" shutil.rmtree('${build_folder}')",
123123
"os.makedirs('${build_folder}')"
124124
]
125-
},
125+
},
126126
"/deploy": {
127127
"start_point": true
128128
}

‎docs/api_docs/Makefile‎ renamed to ‎docs/Makefile‎

File renamed without changes.

‎docs/NXTStage.md‎

Lines changed: 0 additions & 147 deletions
This file was deleted.

‎docs/api_docs/api_docs.md‎ renamed to ‎docs/api_docs.md‎

File renamed without changes.

‎docs/api_docs/source/index.rst‎

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎docs/doc_setup.md‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎docs/api_docs/docs_env.yml‎ renamed to ‎docs/docs_env.yml‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@ name: nxtdocs
22
channels:
33
- conda-forge
44
dependencies:
5-
- python=2.7
6-
- qt.py=1.1
7-
- pyside2=5.6
8-
- pip
5+
- nxt-core
96
- pip:
107
- sphinx
118
- sphinx-rtd-theme

‎docs/api_docs/make.bat‎ renamed to ‎docs/make.bat‎

File renamed without changes.

0 commit comments

Comments
 (0)