Replace tool HTML help with Sphinx-generated docs

[alexxy/gromacs.git] / src / gromacs / onlinehelp / helpwritercontext.cpp

diff --git a/src/gromacs/onlinehelp/helpwritercontext.cpp b/src/gromacs/onlinehelp/helpwritercontext.cpp
index 8ede31c71a48586095d50add97f27983b3c504a6..0c8870e78772146fc4118935a760dbe3d92af52c 100644 (file)
--- a/src/gromacs/onlinehelp/helpwritercontext.cpp
+++ b/src/gromacs/onlinehelp/helpwritercontext.cpp
@@ -1,7 +1,7 @@
 /*
  * This file is part of the GROMACS molecular simulation package.
  *
- * Copyright (c) 2012,2013,2014, by the GROMACS development team, led by
+ * Copyright (c) 2012,2013,2014,2015, by the GROMACS development team, led by
  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
  * and including many others, as listed in the AUTHORS file in the
  * top-level source directory and at http://www.gromacs.org.
@@ -81,6 +81,8 @@ struct t_sandr
 
 //! List of replacements for console output.
 const t_sandr sandrTty[] = {
+    { "\\*", "*" },
+    { "\\=", "=" },
     { "[TT]", "" },
     { "[tt]", "" },
     { "[BB]", "" },
@@ -133,6 +135,8 @@ const t_sandr sandrTty[] = {
 
 //! List of replacements for man page output.
 const t_sandr sandrMan[] = {
+    { "\\*", "*" },
+    { "\\=", "=" },
     { "[TT]", "\\fB" },
     { "[tt]", "\\fR" },
     { "[BB]", "\\fB" },
@@ -192,22 +196,20 @@ const t_sandr sandrMan[] = {
     { "[grk]", "" }
 };
 
-//! List of replacements for HTML output.
-const t_sandr sandrHtml[] = {
-    { "<",    "&lt;" },
-    { ">",    "&gt;" },
-    { "[TT]", "<tt>" },
-    { "[tt]", "</tt>" },
-    { "[BB]", "<b>" },
-    { "[bb]", "</b>" },
-    { "[IT]", "<it>" },
-    { "[it]", "</it>" },
+//! List of replacements for reStructuredText output.
+const t_sandr sandrRst[] = {
+    { "[TT]", "``" },
+    { "[tt]", "``" },
+    { "[BB]", "**" },
+    { "[bb]", "**" },
+    { "[IT]", "*" },
+    { "[it]", "*" },
     { "[MATH]", "" },
     { "[math]", "" },
-    { "[CHEVRON]", "&lt;" },
-    { "[chevron]", "&gt;" },
-    { "[MAG]", "|" },
-    { "[mag]", "|" },
+    { "[CHEVRON]", "<" },
+    { "[chevron]", ">" },
+    { "[MAG]", "\\|" },
+    { "[mag]", "\\|" },
     { "[INT]", "integral" },
     { "[FROM]", " from " },
     { "[from]", "" },
@@ -219,7 +221,7 @@ const t_sandr sandrHtml[] = {
     { "[SUB]", "_" },
     { "[sub]", "" },
     { "[SQRT]", "sqrt(" },
-    { "[sqrt]", ")", },
+    { "[sqrt]", ")" },
     { "[EXP]", "exp(" },
     { "[exp]", ")" },
     { "[LN]", "ln(" },
@@ -238,13 +240,11 @@ const t_sandr sandrHtml[] = {
     { "[sinh]", ")" },
     { "[TANH]", "tanh(" },
     { "[tanh]", ")" },
-    { "[PAR]", "<p>" },
-    { "[BR]", "<br>" },
-    { "[UL]", "<ul>" },
-    { "[LI]", "<li>" },
-    { "[ul]", "</ul>" },
-    { "[GRK]", "&"  },
-    { "[grk]", ";"  }
+    { "[PAR]", "\n\n" },
+    // [BR] is fundamentally incompatible with rst
+    { "[BR]", "\n\n"},
+    { "[GRK]", "" },
+    { "[grk]", "" }
 };
 
 /*! \brief
@@ -429,10 +429,10 @@ void HelpLinks::addLink(const std::string &linkName,
         case eHelpOutputFormat_Man:
             replacement = repall(displayName, sandrMan);
             break;
-        case eHelpOutputFormat_Html:
+        case eHelpOutputFormat_Rst:
             replacement = formatString(
-                        "<a href=\"%s.html\">%s</a>", targetName.c_str(),
-                        repall(displayName, sandrHtml).c_str());
+                        ":doc:`%s <%s>`", repall(displayName, sandrTty).c_str(),
+                        targetName.c_str());
             break;
         default:
             GMX_RELEASE_ASSERT(false, "Output format not implemented for links");
@@ -579,9 +579,9 @@ void HelpWriterContext::Impl::processMarkup(const std::string &text,
             result = repall(result, sandrMan);
             return wrapper->wrap(result);
         }
-        case eHelpOutputFormat_Html:
+        case eHelpOutputFormat_Rst:
         {
-            result = repall(result, sandrHtml);
+            result = repall(result, sandrRst);
             result = replaceLinks(result);
             return wrapper->wrap(result);
         }
@@ -670,8 +670,9 @@ void HelpWriterContext::writeTitle(const std::string &title) const
         case eHelpOutputFormat_Man:
             file.writeLine(formatString(".SH %s", toUpperCase(title).c_str()));
             break;
-        case eHelpOutputFormat_Html:
-            file.writeLine(formatString("<H3>%s</H3>", title.c_str()));
+        case eHelpOutputFormat_Rst:
+            file.writeLine(title);
+            file.writeLine(std::string(title.length(), '-'));
             break;
         default:
             GMX_THROW(NotImplementedError(
@@ -691,10 +692,6 @@ void HelpWriterContext::writeTextBlock(const std::string &text) const
 
 void HelpWriterContext::writeOptionListStart() const
 {
-    if (outputFormat() == eHelpOutputFormat_Html)
-    {
-        outputFile().writeLine("<dl>");
-    }
 }
 
 void HelpWriterContext::writeOptionItem(const std::string &name,
@@ -715,15 +712,12 @@ void HelpWriterContext::writeOptionItem(const std::string &name,
             writeTextBlock(description);
             file.writeLine();
             break;
-        case eHelpOutputFormat_Html:
+        case eHelpOutputFormat_Rst:
         {
-            std::string substArgs =
-                substituteMarkupAndWrapToString(TextLineWrapperSettings(), args);
-            file.writeLine(formatString("<dt><b><tt>%s</tt></b> %s</dt>", name.c_str(),
-                                        substArgs.c_str()));
-            file.writeLine("<dd>");
-            writeTextBlock(description);
-            file.writeLine("</dd>");
+            file.writeLine(formatString("``%s`` %s", name.c_str(), args.c_str()));
+            TextLineWrapperSettings settings;
+            settings.setIndent(4);
+            file.writeLine(substituteMarkupAndWrapToString(settings, description));
             break;
         }
         default:
@@ -734,10 +728,6 @@ void HelpWriterContext::writeOptionItem(const std::string &name,
 
 void HelpWriterContext::writeOptionListEnd() const
 {
-    if (outputFormat() == eHelpOutputFormat_Html)
-    {
-        outputFile().writeLine("</dl>");
-    }
 }
 
 } // namespace gmx