Skip to content
This repository has been archived by the owner on Apr 19, 2024. It is now read-only.

Latest commit

 

History

History
287 lines (165 loc) · 7.81 KB

CHANGES.md

File metadata and controls

287 lines (165 loc) · 7.81 KB
Raw

restdown Changelog

restdown 1.4.2 (not yet released)

(nothing yet)

restdown 1.4.1

  • Allow us to run in environments where python3.x is the default python

restdown 1.4.0

  • restdown -J,--no-json option to NOT generate the API summary .json file. Many uses of restdown just don't use that file.

restdown 1.3.6

  • [issue #25] Correct usage of markdown2 extras.

restdown 1.3.5

  • Update to markdown2 2.3.0 to get GFM 'tables' extra syntax.

restdown 1.3.4

  • Fix missing </span> in API endpoint <h2>s.

restdown 1.3.3

  • Update to markdown2 2.2.3.

restdown 1.3.2

  • Enable anchors on h3, h4, h5 and h6. These still do not show up in the TOC.

restdown 1.3.1

  • [MANTA-1587] Changing handling of h2's in "api sections" that don't look like an API endpoint to NOT be shoehorned into the special HTML anchor generation and TOC HTML styling for endpoints. This is especially important for naive usage of restdown where the "api-sections" metadata key is not used at all -- which tells restdown to treat all sections as using h2's only for endpoints.

    Effectively the difference here is that this doc:

      ---
  title: Blah
  ---

  # Blah

  ... intro ...

  # My section

  ## ListWidgets (GET /widgets)

  ## Another h2 section

    now gets a TOC like this:

      <ul>
    <li><div><a href="#my-section">My section</a></div>
    <ul>
      <li><div><a href="#ListWidgets"><span class="method both"><span class="name">ListWidgets</span> <span class="endpoint">(<span class="verb">GET</span> <span class="path">/widgets</span>)</span></a></div></li>
      <li><div><a href="#another-h2-section">Another h2 section</a></div></li>
    </ul></li>
  </ul>

    instead of one with a broke anchor for "Another h2 section" like this:

      <ul>
    <li><div><a href="#my-section">My section</a></div>
    <ul>
      <li><div><a href="#ListWidgets"><span class="method both"><span class="name">ListWidgets</span> <span class="endpoint">(<span class="verb">GET</span> <span class="path">/widgets</span>)</span></a></div></li>
      <li><div><a href="#Another"><span class="method name"><span class="name">Another h2 section</span></span></a></div></li>
    </ul></li>
  </ul>

restdown 1.3.0

  • Add support for using link-patterns in restdown docs. You need the following in your restdown doc header:

      markdown2extras: ..., link-patterns, ...
  markdown2linkpatternsfile: link-patterns.txt

    where "markdown2linkpatternsfile" is a path to a link patterns file (relative to the restdown document path). That file must be in the format described in the markdown2 link-patterns link above. E.g., Jira ticket linking might be done like this:

      /([A-Z]+-\d+)/ https://example.com/jira/browse/\1

restdown 1.2.24

  • [pull #18] Added PATCH/LINK/UNLINK methods. (by Carsten Saathoff, github.com/kodemaniak)

restdown 1.2.23

  • Remove debugging print in 1.2.22. Sigh.

restdown 1.2.22

  • [issue #17] Fix <pre class="shell"><code>$ ...</code></pre> handling. Was broken in 1.2.21 or 1.2.20.

restdown 1.2.21

  • More fixing of headers with escaped Markdown chars (e.g. "foo\_bar").

restdown 1.2.20

  • [issue #15] Unescape escaped chars in Table on Contents entries. The underlying issue was markdown2.py (fixed in markdown2 2.0.1).

restdown 1.2.19

  • [issue #14] Only take first token in h2 api endpoint header as the endpoint name.

restdown 1.2.18

restdown 1.2.17

  • [issue #10] "spartan" brand: Fix the TOC dropdown closing right away in Firefox.

restdown 1.2.16

  • Move to 'cutarelease.py' separate tool
  • [issue #9] Fix breakage if there are no TOC sections, i.e. no second h1 in the input restdown content.

restdown 1.2.15

  • "spartan" brand: Fix path to jquery if using a "mediaroot" config value other than the defualt "/media".

restdown 1.2.14

  • [issue #4] "ohthejoy" brand: Text in tables should align to the top of the cells. Also some table top/bottom margins.
  • [issue #3] "ohthejoy" brand: Bullets in lists should hang.

restdown 1.2.13

  • [issue #6] "spartan" brand:
    • Blue default logo color, instead of pink.
    • TOC margin fix for narrow screens.
    • Support for "logo-color", "logo-font-family" and "header-font-family" metadata (see README.md for description).
    • Slightly wider (650px -> 700px).
    • Restore "pre.shell" styling from "ohthejoy" brand.

restdown 1.2.12

  • New "spartan" brand.
  • If %(toc_html)s appears in the "header.html.in" or "footer.html.in" files, then the <div id="sidebar">%(toc_html)s</div> is excluded. This allows one to customize where the TOC html appears. Note: an metadata option should be added to more explicitly control this.

restdown 1.2.11

  • Add the "markdown2extras" metadata var to enable turning on markdown2 extra syntax for the processed document. See https://github.com/trentm/python-markdown2/wiki/Extras.
  • Upgrade to python-markdown2 1.0.1.19.
  • Use realpath as appropriate so can run restdown as a symlink.

restdown 1.2.10

  • Fix bug in "-d|--define".

restdown 1.2.9

  • Add "-d|--define" option for providing metadata on the command line.

restdown 1.2.8

  • ["ohthejoy" brand] Fix issue with "current section" highlighting in the TOC: for the h1's the whole section would be highlighted instead of just the h1 link.

restdown 1.2.7

  • Fix a bug handling an empty "apisections" metadatum.

restdown 1.2.6

  • [issue #2, "ohthejoy" brand] Add support for method h2's being in other of the following formats:

    1. "NAME (VERB PATH)", e.g. "ListMachines (GET /:login/machines)". Only NAME is shown in table of contents and used for the section anchor. Reasonable styling in content. Only "VERB PATH" is used in ".json" API summary file.
    2. "VERB PATH", e.g. "DELETE /zones/:uuid"
    3. "NAME", e.g. "DoIt"

    Note: It is possible the markup changes here break other brands.

  • Add 'apisections' document metadatum. It is a comma-separated list of h1 section names that are to be considered the API endpoint sections (i.e. an h1 section in which h1's define REST API endpoints). If 'apisections' is not specified it is presumed that all sections except the first (presumed to be a preface section) are API sections. This is related to issue #2, but not a complete fix yet.

  • Add support for 'mediaroot' document metadatum to control the URL from which brand media is pulled.

restdown 1.2.5

  • ["ohthejoy" brand] Switch to background gradient for current TOC item instead of arrow: easier to see than the arrow for larger APIs.
  • ["ohthejoy" brand] Don't let TOC labels wrap (helpful for longer TOC titles)
  • ["ohthejoy" brand] Give the TOC arrow header some scrolling slack.

restdown 1.2.4

  • Fix TOC handling to skip h2's in the intro section.

restdown 1.2.3

  • ["ohthejoy" brand] Fix print styling of pre.shell blocks.
  • ["ohthejoy" brand] Reasonable default table styles.

restdown 1.2.2

  • New default "ohthejoy" brand. Improvements:
    • Header styling for better section separation.
    • Fix TOC arrow to point all toc elements (also not be dependent on "VERB URLPATH" header text form).
    • Remove the fixed top-right section header: not that helpful, often broken.
  • Strip trailing whitespace in create api JSON file.

restdown 1.2.1

  • [issue #1] Allow h2 text (for endpoints) to NOT be the "VERB URLPATH" format.

restdown 1.2.0

  • Add "-b|--brand-dir DIR" option for specifying a local brand dir to use.

restdown 1.1.0

(Started this changelog on 5 May 2011.)