Merge lp:~nskaggs/autopilot/apdocs-restruct into lp:autopilot
- apdocs-restruct
- Merge into trunk
Status: | Merged |
---|---|
Approved by: | Leo Arias |
Approved revision: | 528 |
Merged at revision: | 533 |
Proposed branch: | lp:~nskaggs/autopilot/apdocs-restruct |
Merge into: | lp:autopilot |
Diff against target: |
185 lines (+86/-53) 4 files modified
docs/_templates/indexcontent.html (+74/-44) docs/contents.rst (+3/-0) docs/index.rst (+9/-6) docs/tutorial/tutorial.rst (+0/-3) |
To merge this branch: | bzr merge lp:~nskaggs/autopilot/apdocs-restruct |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
PS Jenkins bot | continuous-integration | Approve | |
Allan LeSage (community) | Approve | ||
Christopher Lee (community) | Approve | ||
Thomi Richards (community) | Needs Fixing | ||
Leo Arias (community) | Needs Information | ||
Review via email: mp+246599@code.launchpad.net |
Commit message
Initial restructuring for the autopilot docs.
Description of the change
Initial restructuring for the autopilot docs. I pulled out specific sections to shorten the tutorial and make them more prominent on the contents page instead.
Leo Arias (elopio) wrote : | # |
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:521
http://
Executed test runs:
SUCCESS: http://
deb: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
deb: http://
UNSTABLE: http://
UNSTABLE: http://
SUCCESS: http://
deb: http://
Click here to trigger a rebuild:
http://
Leo Arias (elopio) wrote : | # |
I like how the index looks. But shouldn't you move these files:
79 + tutorial/
81 + tutorial/good_tests
82 + tutorial/running_ap
out of the tutorial directory?
Nicholas Skaggs (nskaggs) wrote : | # |
Leo, I suppose so. Perhaps I'll create another directory to house them.
Nicholas Skaggs (nskaggs) wrote : | # |
Reminder for that balloons guys; add installing_
Christopher Lee (veebers) wrote : | # |
I get a warning when building the docs:
..snip.
The order that the resulting menu has me pondering what the order should be.
Personally I read the column: 1st column top-to-bottom then the 2nd column top-to-bottom.
This means I see the API reference and appendice before I see mention of the tutorial.
(This way of reading it seems correct with the original layout).
If I'm an oddball though, and the only one that doesn't read it that way then this is ok. I suspect that I'm not though (i.e. reading columns, newspapers for instance, is really top to bottom then next column.) (I might still be an oddball, but not when it comes to reading columns).
Leo Arias (elopio) wrote : | # |
That warning is fixed in a branch by thomi. Seems to come from before.
Nicholas Skaggs (nskaggs) wrote : | # |
> The order that the resulting menu has me pondering what the order should be.
>
> Personally I read the column: 1st column top-to-bottom then the 2nd column
> top-to-bottom.
>
I obviously read left to right, then top to bottom. So left, right, next row and so on. I will change it to read like a newspaper. I suspect I might be alone in reading it this way.
Thomi Richards (thomir-deactivatedaccount) wrote : | # |
I agree with veebers' comments, and added one of my own. Otherwise, looks good.
PS Jenkins bot (ps-jenkins) wrote : | # |
PASSED: Continuous integration, rev:524
http://
Executed test runs:
SUCCESS: http://
deb: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
deb: http://
UNSTABLE: http://
SUCCESS: http://
UNSTABLE: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
SUCCESS: http://
deb: http://
Click here to trigger a rebuild:
http://
PS Jenkins bot (ps-jenkins) wrote : | # |
PASSED: Continuous integration, rev:525
http://
Executed test runs:
SUCCESS: http://
deb: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
deb: http://
UNSTABLE: http://
SUCCESS: http://
UNSTABLE: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
SUCCESS: http://
deb: http://
Click here to trigger a rebuild:
http://
PS Jenkins bot (ps-jenkins) wrote : | # |
PASSED: Continuous integration, rev:526
http://
Executed test runs:
SUCCESS: http://
deb: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
deb: http://
UNSTABLE: http://
SUCCESS: http://
UNSTABLE: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
SUCCESS: http://
deb: http://
Click here to trigger a rebuild:
http://
Allan LeSage (allanlesage) wrote : | # |
Following these changes, arrived late, no objection.
PS Jenkins bot (ps-jenkins) wrote : | # |
PASSED: Continuous integration, rev:527
http://
Executed test runs:
SUCCESS: http://
deb: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
deb: http://
UNSTABLE: http://
SUCCESS: http://
UNSTABLE: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
SUCCESS: http://
SUCCESS: http://
deb: http://
Click here to trigger a rebuild:
http://
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Autolanding.
More details in the following jenkins job:
http://
Executed test runs:
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Autolanding.
More details in the following jenkins job:
http://
Executed test runs:
SUCCESS: http://
deb: http://
SUCCESS: http://
deb: http://
SUCCESS: http://
deb: http://
UNSTABLE: http://
UNSTABLE: http://
SUCCESS: http://
deb: http://
PS Jenkins bot (ps-jenkins) : | # |
Preview Diff
1 | === modified file 'docs/_templates/indexcontent.html' |
2 | --- docs/_templates/indexcontent.html 2014-05-20 22:19:53 +0000 |
3 | +++ docs/_templates/indexcontent.html 2015-01-22 16:18:29 +0000 |
4 | @@ -7,54 +7,84 @@ |
5 | <tr> |
6 | <td width="50%"> |
7 | <p class="biglink"> |
8 | - <a class="biglink" href="{{ pathto("tutorial/tutorial") }}">Autopilot Tutorial</a><br/> |
9 | - <span class="linkdescr">Grok Autopilot!</span> |
10 | - </p> |
11 | - </td> |
12 | - <td width="50%"> |
13 | - <p class="biglink"> |
14 | - <a class="biglink" href="{{ pathto("api/index") }}">API Reference</a><br/> |
15 | - <span class="linkdescr">API reference documentation for Autopilot.</span> |
16 | - </p> |
17 | - </td> |
18 | - </tr> |
19 | - <tr> |
20 | - <td> |
21 | - <p class="biglink"> |
22 | - <a class="biglink" href="{{ pathto("faq/faq") }}">Frequently Asked Questions</a><br/> |
23 | - <span class="linkdescr">...with answers!</span> |
24 | - </p> |
25 | - </td> |
26 | - <td> |
27 | - <p class="biglink"> |
28 | - <a class="biglink" href="{{ pathto("faq/troubleshooting") }}">How To Troubleshoot My Failing Test</a><br/> |
29 | - <span class="linkdescr">My test works sometimes</span> |
30 | - </p> |
31 | - </td> |
32 | - </tr> |
33 | - <tr> |
34 | - <td> |
35 | - <p class="biglink"> |
36 | - <a class="biglink" href="{{ pathto("porting/porting") }}">Porting Autopilot Tests</a><br/> |
37 | - <span class="linkdescr">How to port your tests from earlier versions of Autopilot.</span> |
38 | - </p> |
39 | - </td> |
40 | - <td> |
41 | - <p class="biglink"> |
42 | - <a class="biglink" href="{{ pathto("appendix/appendix") }}">Appendices</a><br/> |
43 | - <span class="linkdescr">Technical documentation that doesn't fit anywhere else.</span> |
44 | - </p> |
45 | + <a class="biglink" href="{{ pathto("tutorial/what_is_autopilot") }}">What is Autopilot?</a><br/> |
46 | + <span class="linkdescr">... and who is Otto anyway?</span> |
47 | + </p> |
48 | + </td> |
49 | + <td width="50%"> |
50 | + <p class="biglink"> |
51 | + <a class="biglink" href="{{ pathto("faq/faq") }}">Frequently Asked Questions</a><br/> |
52 | + <span class="linkdescr">... with answers!</span> |
53 | + </p> |
54 | + </td> |
55 | + </tr> |
56 | + <tr> |
57 | + <td width="50%"> |
58 | + <p class="biglink"> |
59 | + <a class="biglink" href="{{ pathto("tutorial/tutorial") }}">Autopilot Tutorial</a><br/> |
60 | + <span class="linkdescr">Grok Autopilot!</span> |
61 | + </p> |
62 | + </td> |
63 | + <td width="50%"> |
64 | + <p class="biglink"> |
65 | + <a class="biglink" href="{{ pathto("porting/porting") }}">Porting Autopilot Tests</a><br/> |
66 | + <span class="linkdescr">How to port your tests from earlier versions of Autopilot.</span> |
67 | + </p> |
68 | + </td> |
69 | + </tr> |
70 | + <tr> |
71 | + <td width="50%"> |
72 | + <p class="biglink"> |
73 | + <a class="biglink" href="{{ pathto("guides/running_ap") }}">Running Tests</a><br/> |
74 | + <span class="linkdescr">How do I start this thing?</span> |
75 | + </p> |
76 | + </td> |
77 | + <td width="50%"> |
78 | + <p class="biglink"> |
79 | + <a class="biglink" href="{{ pathto("api/index") }}">API Reference</a><br/> |
80 | + <span class="linkdescr">API reference documentation for Autopilot.</span> |
81 | + </p> |
82 | + </td> |
83 | + </tr> |
84 | + <tr> |
85 | + <td width="50%"> |
86 | + <p class="biglink"> |
87 | + <a class="biglink" href="{{ pathto("guides/good_tests") }}">Writing Good Tests</a><br/> |
88 | + <span class="linkdescr">Tips to bring out the test writer in you.</span> |
89 | + </p> |
90 | + </td> |
91 | + <td width="50%"> |
92 | + <p class="biglink"> |
93 | + <a class="biglink" href="{{ pathto("appendix/appendix") }}">Appendices</a><br/> |
94 | + <span class="linkdescr">Technical documentation that doesn't fit anywhere else.</span> |
95 | + </p> |
96 | + </td> |
97 | + </tr> |
98 | + <tr> |
99 | + <td width="50%"> |
100 | + <p class="biglink"> |
101 | + <a class="biglink" href="{{ pathto("faq/troubleshooting") }}">How To Troubleshoot My Failing Test</a><br/> |
102 | + <span class="linkdescr">My test works . . . sometimes . . . </span> |
103 | + </p> |
104 | </td> |
105 | </tr> |
106 | </table> |
107 | |
108 | <h2>Indices and tables:</h2> |
109 | - <table class="contentstable" align="center"><tr> |
110 | - <td width="50%"> |
111 | - <p class="biglink"><a class="biglink" href="{{ pathto("py-modindex") }}">Module Index</a><br/> |
112 | - <span class="linkdescr">quick access to all modules</span></p> |
113 | - <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Complete Table of Contents</a><br/> |
114 | - <span class="linkdescr">lists all sections and subsections</span></p> |
115 | - </td></tr> |
116 | + <table class="contentstable" align="center"> |
117 | + <tr> |
118 | + <td width="50%"> |
119 | + <p class="biglink"> |
120 | + <a class="biglink" href="{{ pathto("py-modindex") }}">Module Index</a><br/> |
121 | + <span class="linkdescr">quick access to all modules.</span> |
122 | + </p> |
123 | + </td> |
124 | + <td width="50%"> |
125 | + <p class="biglink"> |
126 | + <a class="biglink" href="{{ pathto("contents") }}">Complete Table of Contents</a><br/> |
127 | + <span class="linkdescr">lists all sections and subsections.</span> |
128 | + </p> |
129 | + </td> |
130 | + </tr> |
131 | </table> |
132 | {% endblock %} |
133 | |
134 | === modified file 'docs/contents.rst' |
135 | --- docs/contents.rst 2015-01-22 00:27:52 +0000 |
136 | +++ docs/contents.rst 2015-01-22 16:18:29 +0000 |
137 | @@ -6,7 +6,10 @@ |
138 | .. toctree:: |
139 | :maxdepth: 5 |
140 | |
141 | + tutorial/what_is_autopilot |
142 | tutorial/tutorial |
143 | + guides/good_tests |
144 | + guides/running_ap |
145 | api/index |
146 | porting/porting |
147 | guides/page_object |
148 | |
149 | === renamed file 'docs/tutorial/good_tests.rst' => 'docs/guides/good_tests.rst' |
150 | === renamed file 'docs/tutorial/running_ap.rst' => 'docs/guides/running_ap.rst' |
151 | === modified file 'docs/index.rst' |
152 | --- docs/index.rst 2014-04-29 19:41:07 +0000 |
153 | +++ docs/index.rst 2015-01-22 16:18:29 +0000 |
154 | @@ -2,9 +2,12 @@ |
155 | ################################## |
156 | |
157 | .. toctree:: |
158 | - tutorial/tutorial |
159 | - api/index |
160 | - faq/faq |
161 | - porting/porting |
162 | - appendix/appendix |
163 | - man |
164 | + tutorial/what_is_autopilot |
165 | + tutorial/tutorial |
166 | + guides/good_tests |
167 | + guides/running_ap |
168 | + api/index |
169 | + faq/faq |
170 | + porting/porting |
171 | + appendix/appendix |
172 | + man |
173 | |
174 | === modified file 'docs/tutorial/tutorial.rst' |
175 | --- docs/tutorial/tutorial.rst 2013-04-16 22:51:59 +0000 |
176 | +++ docs/tutorial/tutorial.rst 2015-01-22 16:18:29 +0000 |
177 | @@ -6,10 +6,7 @@ |
178 | .. toctree:: |
179 | :maxdepth: 3 |
180 | |
181 | - what_is_autopilot |
182 | getting_started |
183 | advanced_autopilot |
184 | - good_tests |
185 | - running_ap |
186 | |
187 |
Makes sense to me. I haven't built the docs yet, I will do it after lunch.