other tools: cleanup and synchronize options with the manpage

[nit.git] / src / doc / doc_phases / doc_html.nit

diff --git a/src/doc/doc_phases/doc_html.nit b/src/doc/doc_phases/doc_html.nit
index ebc1193..c120b0a 100644 (file)
--- a/src/doc/doc_phases/doc_html.nit
+++ b/src/doc/doc_phases/doc_html.nit
@@ -28,35 +28,35 @@ import html_templates
 redef class ToolContext
 
        # File pattern used to link documentation to source code.
-       var opt_source = new OptionString("link for source (%f for filename, " +
+       var opt_source = new OptionString("Format to link source code (%f for filename, " +
                "%l for first line, %L for last line)", "--source")
 
        # Directory where the CSS and JS is stored.
-       var opt_sharedir = new OptionString("directory containing nitdoc assets", "--sharedir")
+       var opt_sharedir = new OptionString("Directory containing nitdoc assets", "--sharedir")
 
        # Use a shareurl instead of copy shared files.
        #
        # This is usefull if you don't want to store the Nitdoc templates with your
        # documentation.
-       var opt_shareurl = new OptionString("use shareurl instead of copy shared files", "--shareurl")
+       var opt_shareurl = new OptionString("Use shareurl instead of copy shared files", "--shareurl")
 
        # Use a custom title for the homepage.
-       var opt_custom_title = new OptionString("custom title for homepage", "--custom-title")
+       var opt_custom_title = new OptionString("Custom title for homepage", "--custom-title")
 
        # Display a custom brand or logo in the documentation top menu.
-       var opt_custom_brand = new OptionString("custom link to external site", "--custom-brand")
+       var opt_custom_brand = new OptionString("Custom link to external site", "--custom-brand")
 
        # Display a custom introduction text before the packages overview.
-       var opt_custom_intro = new OptionString("custom intro text for homepage", "--custom-overview-text")
+       var opt_custom_intro = new OptionString("Custom intro text for homepage", "--custom-overview-text")
        # Display a custom footer on each documentation page.
        #
        # Generally used to display the documentation or product version.
-       var opt_custom_footer = new OptionString("custom footer text", "--custom-footer-text")
+       var opt_custom_footer = new OptionString("Custom footer text", "--custom-footer-text")
 
        # Piwik tracker URL.
        #
        # If you want to monitor your visitors.
-       var opt_piwik_tracker = new OptionString("Piwik tracker URL (ex: nitlanguage.org/piwik/)", "--piwik-tracker")
+       var opt_piwik_tracker = new OptionString("Piwik tracker URL (ex: `nitlanguage.org/piwik/`)", "--piwik-tracker")
 
        # Piwik tracker site id.
        var opt_piwik_site_id = new OptionString("Piwik site ID", "--piwik-site-id")
@@ -70,6 +70,9 @@ redef class ToolContext
        # FIXME redo the plugin
        var opt_github_gitdir = new OptionString("Git working directory used to resolve path name (ex: /home/me/mypackage/)", "--github-gitdir")
 
+       # Do not produce HTML files
+       var opt_no_render = new OptionBool("do not render HTML files", "--no-render")
+
        redef init do
                super
 
@@ -77,7 +80,8 @@ redef class ToolContext
                        opt_source, opt_sharedir, opt_shareurl, opt_custom_title,
                        opt_custom_footer, opt_custom_intro, opt_custom_brand,
                        opt_github_upstream, opt_github_base_sha1, opt_github_gitdir,
-                       opt_piwik_tracker, opt_piwik_site_id)
+                       opt_piwik_tracker, opt_piwik_site_id,
+                       opt_no_render)
        end
 
        redef fun process_options(args) do
@@ -103,6 +107,7 @@ class RenderHTMLPhase
        var name_sorter = new MEntityNameSorter
 
        redef fun apply do
+               if ctx.opt_no_render.value then return
                init_output_dir
                for page in doc.pages.values do
                        page.render(self, doc).write_to_file("{ctx.output_dir.to_s}/{page.html_url}")