Improve ReST export

[Ryan J Ollos]

Copied from 11914#comment:22:

---

Remained issues:

• `mod_python`_ and `CGI`_ don't work. Link and italic markups cannot be nested in ReST.
• One of `trac- admin`_ doesn't work due to wrapped the link.
• `SilverCity`_ doesn't work.
• ` [trac] htdocs_location`_ doesn't work.
• Some Title level inconsistent:// errors.

---

Also:

• Links to anchors in the document direct back to wiki trac.edgewall.org

Using ​pypandoc rather than ​html2rest fixes some of the title level inconsistencies, and other markup problems. It also appears to be well-maintained, whereas html2rest hasn't been updated since 2012.

[Ryan J Ollos]

Edited TracDev/ReleaseChecklist@115.

[Ryan J Ollos]

It appears that html2rest is inserting ZWSPs (r16171):

@@ -106,15 +79,15 @@ See `<U+200B>DatabaseBackend`_ for details.
 For the MySQL database
 ``````````````````````

-Trac works well with MySQL, provided you follow the guidelines:
+Trac works well with MySQL, provided you use the following:


 + `<U+200B>MySQL`_, version 5.0 or later
-+ `<U+200B>MySQLdb`_, version 1.2.2 or later
++ `<U+200B>PyMySQL`_


 Given the caveats and known issues surrounding MySQL, read carefully
-the `<U+200B>MySqlDb*`_ page before creating the database.
+the `<U+200B>MySqlDb`_ page before creating the database.


 Optional Dependencies

[Ryan J Ollos]

Replying to Ryan J Ollos:

It appears that html2rest is inserting ZWSPs (r16171):

Or failing to strip them out, rather.

See also: comment:2:ticket:13177.

[Ryan J Ollos]

Committed variant of comment:2:ticket:13177 patch in r17001, updated INSTALL.rst and UPGRADE.rst in r17002.

[Ryan J Ollos]

Committed comment:5:ticket:13177 fix in r17075.

[Ryan J Ollos]

Replying to Ryan J Ollos:

Copied from 11914#comment:22:

---

Remained issues: …

Edited:

• 1.3/TracUpgrade@29
• 1.3/TracUpgrade@31
• 1.3/TracInstall@16
• 1.3/TracInstall@17
• 1.3/TracInstall@18

• Links to anchors in the document direct back to wiki trac.edgewall.org

This might be worth the effort to fix someday.

Using ​pypandoc rather than ​html2rest fixes some of the title level inconsistencies, and other markup problems. It also appears to be well-maintained, whereas html2rest hasn't been updated since 2012.

Here are the changes I had worked on: log:rjollos.git:t12835_improve_rest_export

Documentation changes committed in r17085. I think this is enough improvement for 1.4.

[Ryan J Ollos]

wiki2rst.py modifies links​ to avoid duplicates by adding one or more * characters. The same could probably be done using a pandoc filter. However, it seems easier to just use ​anonymous inline links by not using the ​--reference-links option.

[Ryan J Ollos]

• [08f8007fe/rjollos.git]
• [e5707d626/rjollos.git]

[Ryan J Ollos]

If no problems found, I'll commit [1fdae527/rjollos.git] and [4ebaefd6/rjollos.git] ahead of #12130.

[Ryan J Ollos]

On the TracInstall page, [#DeployingTrac Deploying Trac] is formatted to HTML:

<a class="wiki" href="/wiki/TracInstall#DeployingTrac">Deploying Trac</a>

Shouldn't it just be?:

<a class="wiki" href="#DeployingTrac">Deploying Trac</a>

[Ryan J Ollos]

I plan to spend some more time on this, but here is work so far: log:rjollos.git:t12835_pandoc.

[8b56ee226/rjollos.git] addresses the issue I posted to the ​pandoc mailing list. The internal links work correctly when rendered with docutils, both in Trac brower and generated using:

rst2html5.py INSTALL.rst > INSTALL.html

[Ryan J Ollos]

Proposed changes: log:rjollos.git:t12835_pandoc.1.

[Ryan J Ollos]

Committed to trunk in r17403.