Activities/Help/Contribute: Difference between revisions

Line 107:

* In any other Linux environment

The output ~~of make~~ html ~~is in /mainline~~/~~html~~, and is opened by opening

The output directory {{Code|html/}}, and is opened by opening

index.html in a browser, it is easy to see the changes as you work.

{{Code|html/index.html}} in a browser, so it is easy to see the changes as you work.

== Further reading ==

Line 130:

b. or in the event you wish to make changes to the index, over and above, adding a new line to the bottom a table of contents as described in the tutorials,

you may delete all the output files, that is, {{Code|~/~~mainline~~/html/}} and {{Code|~/~~mainline~~/doctrees/}}. They will be regenerated by {{Code|make html}}.

you may delete all the output files, that is, {{Code|~/help-activity/html/}} and {{Code|~/help-activity/doctrees/}}. They will be regenerated by {{Code|make html}}.

=== Reconfigure Help to show View source ===

Line 136:

In Sugar as we already have a View source button in the Frame.

If you are working with the Help software in a browser, you can add a ''View source'' button, which will appear in the navigation panel. You need to alter three lines in {{Code|~/~~mainline~~/source/conf.py}}. Each of the entries listed below comprise a comment line, starting with a "#" followed by the code line. Find each pair of lines in {{Code|conf.py}} and change the value in the code line like this.

If you are working with the Help software in a browser, you can add a ''View source'' button, which will appear in the navigation panel. You need to alter three lines in {{Code|~/help-activity/source/conf.py}}. Each of the entries listed below comprise a comment line, starting with a "#" followed by the code line. Find each pair of lines in {{Code|conf.py}} and change the value in the code line like this.

# Custom sidebar templates, maps document names to template names. ## Edit: Sugar default is without 'sourcelink.html'

@@ Line 107: / Line 107: @@
 * In any other Linux environment
-The output of make html is in /mainline/html, and is opened by opening
+The output directory {{Code|html/}}, and is opened by opening
-index.html in a browser, it is easy to see the changes as you work.
+{{Code|html/index.html}} in a browser, so it is easy to see the changes as you work.
 == Further reading ==
@@ Line 130: / Line 130: @@
 b. or in the event you wish to make changes to the index, over and above, adding a new line to the bottom a table of contents as described in the tutorials,
-you may delete all the output files, that is, {{Code|~/mainline/html/}} and {{Code|~/mainline/doctrees/}}. They will be regenerated by {{Code|make html}}.
+you may delete all the output files, that is, {{Code|~/help-activity/html/}} and {{Code|~/help-activity/doctrees/}}. They will be regenerated by {{Code|make html}}.
 === Reconfigure Help to show View source ===
@@ Line 136: / Line 136: @@
 In Sugar as we already have a View source button in the Frame.
-If you are working with the Help software in a browser, you can add a ''View source'' button, which will appear in the navigation panel. You need to alter three lines in {{Code|~/mainline/source/conf.py}}. Each of the entries listed below comprise a comment line, starting with a "#" followed by the code line. Find each pair of lines in {{Code|conf.py}} and change the value in the code line like this.
+If you are working with the Help software in a browser, you can add a ''View source'' button, which will appear in the navigation panel. You need to alter three lines in {{Code|~/help-activity/source/conf.py}}. Each of the entries listed below comprise a comment line, starting with a "#" followed by the code line. Find each pair of lines in {{Code|conf.py}} and change the value in the code line like this.
   # Custom sidebar templates, maps document names to template names. ## Edit: Sugar default is without 'sourcelink.html'