m2r issue with nicely rewriting md links

issue with nicely rewriting md links

Open KaiSchwarz-cnic opened this issue 5 years ago • 5 comments

We have the following changelog which is generated using auto-changelog (npm package): You can see it published here: https://github.com/hexonet/python-sdk/blob/master/HISTORY.md

### Changelog

All notable changes to this project will be documented in this file. Dates are displayed in UTC.

Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).

#### [1.2.5](https://github.com/hexonet/python-sdk/compare/1.2.4...1.2.5)

> 9 July 2018

- fix six import path [`a9ec1a1`](https://github.com/hexonet/python-sdk/commit/a9ec1a1547637535220b33eb86a8172a53634879)
- updated changelog [`9e775a8`](https://github.com/hexonet/python-sdk/commit/9e775a850af227ecfd227b3b838f989daf63edff)

#### [1.2.4](https://github.com/hexonet/python-sdk/compare/1.2.3...1.2.4)

> 9 July 2018

- updated changelog [`c5601be`](https://github.com/hexonet/python-sdk/commit/c5601beb264c7b7e763e88e11aafcc93da310edd)
- fix six import paths [`e304262`](https://github.com/hexonet/python-sdk/commit/e3042628792eefce6168b93220308b138647c8f0)
- set version 1.2.4 [`655b886`](https://github.com/hexonet/python-sdk/commit/655b88658c9c0b1db1be39af8700eb900a19ec87)

#### [1.2.3](https://github.com/hexonet/python-sdk/compare/1.2.2...1.2.3)

> 9 July 2018

- import renaming [`bd7dc80`](https://github.com/hexonet/python-sdk/commit/bd7dc80c9decaccb480333aa4fe51db0c3722389)
- set version to 1.2.2 [`5642b54`](https://github.com/hexonet/python-sdk/commit/5642b54c25dd3410f699fb54e0f97a4ee1957109)

#### [1.2.2](https://github.com/hexonet/python-sdk/compare/1.2.1...1.2.2)

> 9 July 2018

- try import renaming [`d3fa6ae`](https://github.com/hexonet/python-sdk/commit/d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6)

#### [1.2.1](https://github.com/hexonet/python-sdk/compare/1.2.0...1.2.1)

> 9 July 2018

- test renamed imports [`0999708`](https://github.com/hexonet/python-sdk/commit/09997081ddf7c65a6f25fa1827cfb07fd68f82c5)
- updated changelog [`eb5e6d4`](https://github.com/hexonet/python-sdk/commit/eb5e6d408f088b34172414ed9283fb0fc20e3df3)
- set version 1.2.1 [`2d98115`](https://github.com/hexonet/python-sdk/commit/2d9811500081c0940e3f340af9265b1c66f36893)

#### [1.2.0](https://github.com/hexonet/python-sdk/compare/1.1.0...1.2.0)

> 9 July 2018

- introduced six for py2 and py3 support [`fa7403a`](https://github.com/hexonet/python-sdk/commit/fa7403a9b18dc11b9cf8c74da603c12cee01477a)
- updated changelog [`a0f7e2f`](https://github.com/hexonet/python-sdk/commit/a0f7e2f3418d238f2d4884d786c0d62383d3d0c9)
- apiconnector version 1.2.0 [`85ec52f`](https://github.com/hexonet/python-sdk/commit/85ec52f18007de6a9d37889cd1b20711968749fa)

#### [1.1.0](https://github.com/hexonet/python-sdk/compare/1.0.0...1.1.0)

> 9 July 2018

- added pep8 scripts and code refactoring [`95e0199`](https://github.com/hexonet/python-sdk/commit/95e0199073c19f842778d133ceea8d11a7f64ded)
- added sdk documentation and generator script [`01fe1e0`](https://github.com/hexonet/python-sdk/commit/01fe1e0b858690ad95a3e611b9871067af3132be)
- added changelog and changelog generator script [`a4bd960`](https://github.com/hexonet/python-sdk/commit/a4bd9606e5590388fac9f96c5621a9e03fd125c6)
- update apiconnector version [`f1804eb`](https://github.com/hexonet/python-sdk/commit/f1804eb7bbb48c6e338f5b065dc935820ddcc595)

#### 1.0.0

> 9 July 2018

- initial PyPi package release [`eb2ac4c`](https://github.com/hexonet/python-sdk/commit/eb2ac4c6458a3620938e429878582e0b1ab93f00)
- ignore .vscode subfolder [`67430e3`](https://github.com/hexonet/python-sdk/commit/67430e3419237823839b2946c324a93d7d8de22c)
- added .gitignore [`946bc01`](https://github.com/hexonet/python-sdk/commit/946bc01b7c3505c28400aca50b9d9d4d4de33684)
- Add files via upload [`aa2bc4d`](https://github.com/hexonet/python-sdk/commit/aa2bc4d5f92720c22b7853371ade371e1f95b9dd)
- Create README.md [`400e58b`](https://github.com/hexonet/python-sdk/commit/400e58b5d2c0db4102ad207c65845a537d95aa93)
- fix encoding problem (JIRA: HM-22) + fix in properties() results [`5dc88d4`](https://github.com/hexonet/python-sdk/commit/5dc88d4a85f90a7154d0ccde4df33faff0874591)
- support for python2.5, use HTTP instead of HTTPS for the URL [`88cedbf`](https://github.com/hexonet/python-sdk/commit/88cedbf82075e19a957349dbc14b2836d99f2117)
- support for python > 3; also backward compatible [`2756429`](https://github.com/hexonet/python-sdk/commit/27564296dcd0e0a388ce45b0e77c467e6d927a31)
- Initial commit [`c89c917`](https://github.com/hexonet/python-sdk/commit/c89c917845cda5cef9e4f3a4fb5dc9d022e48006)

The generated HTML File using sphinx + m2r looks like this https://hexonet.github.io/python-sdk/docs/_build/html/changelog.html The generated html code looks like this:


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  
  <!-- Licensed under the Apache 2.0 License -->
  <link rel="stylesheet" type="text/css" href="_static/fonts/open-sans/stylesheet.css" />
  <!-- Licensed under the SIL Open Font License -->
  <link rel="stylesheet" type="text/css" href="_static/fonts/source-serif-pro/source-serif-pro.css" />
  <link rel="stylesheet" type="text/css" href="_static/css/bootstrap.min.css" />
  <link rel="stylesheet" type="text/css" href="_static/css/bootstrap-theme.min.css" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
    <title>Changelog &#8212; hexonet.apiconnector 1.2 documentation</title>
    <link rel="stylesheet" href="_static/guzzle.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="shortcut icon" href="_static/hexonet-favicon.ico"/>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="License" href="license.html" />
    <link rel="prev" title="Upgrading to Newer Releases" href="upgrading.html" />
  
   

  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="license.html" title="License"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="upgrading.html" title="Upgrading to Newer Releases"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">hexonet.apiconnector 1.2 documentation</a> &#187;</li> 
      </ul>
    </div>
    <div class="container-wrapper">

      <div id="mobile-toggle">
        <a href="#"><span class="glyphicon glyphicon-align-justify" aria-hidden="true"></span></a>
      </div>
  <div id="left-column">
    <div class="sphinxsidebar"><a href="
    index.html" class="text-logo">hexonet.apiconnector 1.2.6</a>
<div class="sidebar-block">
  <div class="sidebar-wrapper">
    <h2>Table Of Contents</h2>
  </div>
  <div class="sidebar-toc">
    
    
      <ul>
<li class="toctree-l1"><a class="reference internal" href="foreword.html">Foreword</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="debugging.html">Debugging</a></li>
<li class="toctree-l1"><a class="reference internal" href="config.html">Configuration Handling</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api.html">SDK Documentation</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="upgrading.html">Upgrading to Newer Releases</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id1">Changelog</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html#hexonet-developers">HEXONET Developers</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html#id2">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="contactus.html">Contact Us</a></li>
</ul>

    
  </div>
</div>
<div class="sidebar-block">
  <div class="sidebar-wrapper">
    <h2>Contents</h2>
    <div class="sidebar-localtoc">
      <ul>
<li><a class="reference internal" href="#">Changelog</a><ul>
<li><a class="reference internal" href="#id1">Changelog</a><ul>
<li><a class="reference internal" href="#id3">1.2.5</a></li>
<li><a class="reference internal" href="#id5">1.2.4</a></li>
<li><a class="reference internal" href="#id7">1.2.3</a></li>
<li><a class="reference internal" href="#id9">1.2.2</a></li>
<li><a class="reference internal" href="#id11">1.2.1</a></li>
<li><a class="reference internal" href="#id13">1.2.0</a></li>
<li><a class="reference internal" href="#id15">1.1.0</a></li>
<li><a class="reference internal" href="#id16">1.0.0</a></li>
</ul>
</li>
</ul>
</li>
</ul>

    </div>
  </div>
</div>
<div class="sidebar-block">
  <div class="sidebar-wrapper">
    <div id="main-search">
      <form class="form-inline" action="search.html" method="GET" role="form">
        <div class="input-group">
          <input name="q" type="text" class="form-control" placeholder="Search...">
        </div>
        <input type="hidden" name="check_keywords" value="yes" />
        <input type="hidden" name="area" value="default" />
      </form>
    </div>
  </div>
</div>
      
    </div>
  </div>
        <div id="right-column">
          
          <div role="navigation" aria-label="breadcrumbs navigation">
            <ol class="breadcrumb">
              <li><a href="index.html">Docs</a></li>
              
              <li>Changelog</li>
            </ol>
          </div>
          
          <div class="document clearer body">
            
  <div class="section" id="changelog">
<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h1>
<div class="section" id="id1">
<h2>Changelog<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<p>All notable changes to this project will be documented in this file. Dates are displayed in UTC.</p>
<p>Generated by <cite>``auto-changelog`</cite> &lt;<a class="reference external" href="https://github.com/CookPete/auto-changelog">https://github.com/CookPete/auto-changelog</a>&gt;`_.</p>
<div class="section" id="id3">
<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.4...1.2.5">1.2.5</a><a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div>9 July 2018</div></blockquote>
<ul class="simple">
<li>fix six import path <cite>``a9ec1a1`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/a9ec1a1547637535220b33eb86a8172a53634879">https://github.com/hexonet/python-sdk/commit/a9ec1a1547637535220b33eb86a8172a53634879</a>&gt;`_</li>
<li>updated changelog <cite>``9e775a8`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/9e775a850af227ecfd227b3b838f989daf63edff">https://github.com/hexonet/python-sdk/commit/9e775a850af227ecfd227b3b838f989daf63edff</a>&gt;`_</li>
</ul>
</div>
<div class="section" id="id5">
<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.3...1.2.4">1.2.4</a><a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div>9 July 2018</div></blockquote>
<ul class="simple">
<li>updated changelog <cite>``c5601be`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/c5601beb264c7b7e763e88e11aafcc93da310edd">https://github.com/hexonet/python-sdk/commit/c5601beb264c7b7e763e88e11aafcc93da310edd</a>&gt;`_</li>
<li>fix six import paths <cite>``e304262`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/e3042628792eefce6168b93220308b138647c8f0">https://github.com/hexonet/python-sdk/commit/e3042628792eefce6168b93220308b138647c8f0</a>&gt;`_</li>
<li>set version 1.2.4 <cite>``655b886`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/655b88658c9c0b1db1be39af8700eb900a19ec87">https://github.com/hexonet/python-sdk/commit/655b88658c9c0b1db1be39af8700eb900a19ec87</a>&gt;`_</li>
</ul>
</div>
<div class="section" id="id7">
<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.2...1.2.3">1.2.3</a><a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div>9 July 2018</div></blockquote>
<ul class="simple">
<li>import renaming <cite>``bd7dc80`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/bd7dc80c9decaccb480333aa4fe51db0c3722389">https://github.com/hexonet/python-sdk/commit/bd7dc80c9decaccb480333aa4fe51db0c3722389</a>&gt;`_</li>
<li>set version to 1.2.2 <cite>``5642b54`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/5642b54c25dd3410f699fb54e0f97a4ee1957109">https://github.com/hexonet/python-sdk/commit/5642b54c25dd3410f699fb54e0f97a4ee1957109</a>&gt;`_</li>
</ul>
</div>
<div class="section" id="id9">
<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.1...1.2.2">1.2.2</a><a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div>9 July 2018</div></blockquote>
<ul class="simple">
<li>try import renaming <cite>``d3fa6ae`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6">https://github.com/hexonet/python-sdk/commit/d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6</a>&gt;`_</li>
</ul>
</div>
<div class="section" id="id11">
<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.2.0...1.2.1">1.2.1</a><a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div>9 July 2018</div></blockquote>
<ul class="simple">
<li>test renamed imports <cite>``0999708`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/09997081ddf7c65a6f25fa1827cfb07fd68f82c5">https://github.com/hexonet/python-sdk/commit/09997081ddf7c65a6f25fa1827cfb07fd68f82c5</a>&gt;`_</li>
<li>updated changelog <cite>``eb5e6d4`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/eb5e6d408f088b34172414ed9283fb0fc20e3df3">https://github.com/hexonet/python-sdk/commit/eb5e6d408f088b34172414ed9283fb0fc20e3df3</a>&gt;`_</li>
<li>set version 1.2.1 <cite>``2d98115`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/2d9811500081c0940e3f340af9265b1c66f36893">https://github.com/hexonet/python-sdk/commit/2d9811500081c0940e3f340af9265b1c66f36893</a>&gt;`_</li>
</ul>
</div>
<div class="section" id="id13">
<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.1.0...1.2.0">1.2.0</a><a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div>9 July 2018</div></blockquote>
<ul class="simple">
<li>introduced six for py2 and py3 support <cite>``fa7403a`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/fa7403a9b18dc11b9cf8c74da603c12cee01477a">https://github.com/hexonet/python-sdk/commit/fa7403a9b18dc11b9cf8c74da603c12cee01477a</a>&gt;`_</li>
<li>updated changelog <cite>``a0f7e2f`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/a0f7e2f3418d238f2d4884d786c0d62383d3d0c9">https://github.com/hexonet/python-sdk/commit/a0f7e2f3418d238f2d4884d786c0d62383d3d0c9</a>&gt;`_</li>
<li>apiconnector version 1.2.0 <cite>``85ec52f`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/85ec52f18007de6a9d37889cd1b20711968749fa">https://github.com/hexonet/python-sdk/commit/85ec52f18007de6a9d37889cd1b20711968749fa</a>&gt;`_</li>
</ul>
</div>
<div class="section" id="id15">
<h3><a class="reference external" href="https://github.com/hexonet/python-sdk/compare/1.0.0...1.1.0">1.1.0</a><a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div>9 July 2018</div></blockquote>
<ul class="simple">
<li>added pep8 scripts and code refactoring <cite>``95e0199`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/95e0199073c19f842778d133ceea8d11a7f64ded">https://github.com/hexonet/python-sdk/commit/95e0199073c19f842778d133ceea8d11a7f64ded</a>&gt;`_</li>
<li>added sdk documentation and generator script <cite>``01fe1e0`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/01fe1e0b858690ad95a3e611b9871067af3132be">https://github.com/hexonet/python-sdk/commit/01fe1e0b858690ad95a3e611b9871067af3132be</a>&gt;`_</li>
<li>added changelog and changelog generator script <cite>``a4bd960`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/a4bd9606e5590388fac9f96c5621a9e03fd125c6">https://github.com/hexonet/python-sdk/commit/a4bd9606e5590388fac9f96c5621a9e03fd125c6</a>&gt;`_</li>
<li>update apiconnector version <cite>``f1804eb`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/f1804eb7bbb48c6e338f5b065dc935820ddcc595">https://github.com/hexonet/python-sdk/commit/f1804eb7bbb48c6e338f5b065dc935820ddcc595</a>&gt;`_</li>
</ul>
</div>
<div class="section" id="id16">
<h3>1.0.0<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div>9 July 2018</div></blockquote>
<ul class="simple">
<li>initial PyPi package release <cite>``eb2ac4c`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/eb2ac4c6458a3620938e429878582e0b1ab93f00">https://github.com/hexonet/python-sdk/commit/eb2ac4c6458a3620938e429878582e0b1ab93f00</a>&gt;`_</li>
<li>ignore .vscode subfolder <cite>``67430e3`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/67430e3419237823839b2946c324a93d7d8de22c">https://github.com/hexonet/python-sdk/commit/67430e3419237823839b2946c324a93d7d8de22c</a>&gt;`_</li>
<li>added .gitignore <cite>``946bc01`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/946bc01b7c3505c28400aca50b9d9d4d4de33684">https://github.com/hexonet/python-sdk/commit/946bc01b7c3505c28400aca50b9d9d4d4de33684</a>&gt;`_</li>
<li>Add files via upload <cite>``aa2bc4d`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/aa2bc4d5f92720c22b7853371ade371e1f95b9dd">https://github.com/hexonet/python-sdk/commit/aa2bc4d5f92720c22b7853371ade371e1f95b9dd</a>&gt;`_</li>
<li>Create README.md <cite>``400e58b`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/400e58b5d2c0db4102ad207c65845a537d95aa93">https://github.com/hexonet/python-sdk/commit/400e58b5d2c0db4102ad207c65845a537d95aa93</a>&gt;`_</li>
<li>fix encoding problem (JIRA: HM-22) + fix in properties() results <cite>``5dc88d4`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/5dc88d4a85f90a7154d0ccde4df33faff0874591">https://github.com/hexonet/python-sdk/commit/5dc88d4a85f90a7154d0ccde4df33faff0874591</a>&gt;`_</li>
<li>support for python2.5, use HTTP instead of HTTPS for the URL <cite>``88cedbf`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/88cedbf82075e19a957349dbc14b2836d99f2117">https://github.com/hexonet/python-sdk/commit/88cedbf82075e19a957349dbc14b2836d99f2117</a>&gt;`_</li>
<li>support for python &gt; 3; also backward compatible <cite>``2756429`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/27564296dcd0e0a388ce45b0e77c467e6d927a31">https://github.com/hexonet/python-sdk/commit/27564296dcd0e0a388ce45b0e77c467e6d927a31</a>&gt;`_</li>
<li>Initial commit <cite>``c89c917`</cite> &lt;<a class="reference external" href="https://github.com/hexonet/python-sdk/commit/c89c917845cda5cef9e4f3a4fb5dc9d022e48006">https://github.com/hexonet/python-sdk/commit/c89c917845cda5cef9e4f3a4fb5dc9d022e48006</a>&gt;`_</li>
</ul>
</div>
</div>
</div>


          </div>
            
  <div class="footer-relations">
    
      <div class="pull-left">
        <a class="btn btn-default" href="upgrading.html" title="previous chapter (use the left arrow)">Upgrading to Newer Releases</a>
      </div>
    
      <div class="pull-right">
        <a class="btn btn-default" href="license.html" title="next chapter (use the right arrow)">License</a>
      </div>
    </div>
    <div class="clearer"></div>
  
        </div>
        <div class="clearfix"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="license.html" title="License"
             >next</a> |</li>
        <li class="right" >
          <a href="upgrading.html" title="Upgrading to Newer Releases"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">hexonet.apiconnector 1.2 documentation</a> &#187;</li> 
      </ul>
    </div>
<script type="text/javascript">
  $("#mobile-toggle a").click(function () {
    $("#left-column").toggle();
  });
</script>
<script type="text/javascript" src="_static/js/bootstrap.js"></script>
  <div class="footer">
    &copy; Copyright 2018 by HEXONET GmbH. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
  </div>
  </body>
</html>

Can the link generator be improved so that the visual output fits more to the .md one?

Jul 12 '18 08:07 KaiSchwarz-cnic

Thank you for reporting issue.

Unfortunately, reStructuredText does not seem to support nested inline markup now. http://docutils.sourceforge.net/FAQ.html#is-nested-inline-markup-possible

There are workarounds as shown in the above link, but it's difficult to implement for all cases. So, m2r cannot support this feature soon, sorry.

Jul 12 '18 09:07 miyakogi

ok, ty a lot for checking this. please keep us posted on this matter. Also many thanks for creating and maintaining m2r -> great work! I really like the mdinclude directive - perfect idea!

But still I wonder why you call them "nested" links as in markdown, they are just normal inline links. Maybe I am misunderstanding this... I am wondering why they are getting parsed into such an ugly html format.

Jul 12 '18 10:07 KaiSchwarz-cnic

@papakai Instead of including a huge wall of markdown and HTML, it would be helpful to produce a small example that demonstrates the problem. E.g.

Markdown:

Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog)

HTML:

<p>Generated by <cite>``auto-changelog`</cite> &lt;<a class="reference external" href="https://github.com/CookPete/auto-changelog">https://github.com/CookPete/auto-changelog</a>&gt;`_.</p>

Anyway -- I believe the reason @miyakogi says "nested" is because in the above example, auto-changelog is using code formatting inside of a hyperlink.

Aug 13 '18 01:08 JonathonReinhart

So the simplest workaround is then to change the markdown code into something like

Generated by `[auto-changelog](https://github.com/CookPete/auto-changelog)`

or to leave out that formatting. (not sure if the above works, just a quick shot - will have to try that out)

Aug 17 '18 13:08 KaiSchwarz-cnic

So the simplest workaround is then to change the markdown code into something like

Generated by `[auto-changelog](https://github.com/CookPete/auto-changelog)`

or to leave out that formatting. (not sure if the above works, just a quick shot - will have to try that out)

I think this does not work. It'll be rendered as literal text:

[auto-changelog](https://github.com/CookPete/auto-changelog)

That is, the markdown "single backticks" will be transformed to the rst equivalent: "double backticks".

Sep 04 '18 13:09 sbellem

m2r m2r copied to clipboard

issue with nicely rewriting md links

m2r
m2r copied to clipboard