Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Convert (most of) the ".md" files to rst #7057

Closed
wants to merge 4 commits into from
Closed

Convert (most of) the ".md" files to rst #7057

wants to merge 4 commits into from

Commits on May 28, 2020

  1. Convert Markdown files to RST 

    We use sphinx with rst for our documentation, and github supports rst
here, so it seems weird to have markdown just for these.

It also allows us e.g. to include the CHANGELOG in the docs without
requiring another build dependency.
    @faho
    faho committed May 28, 2020
    Configuration menu
    Copy the full SHA
    6710489 View commit details
    Browse the repository at this point in the history

  2. Update some .md references

    @faho
    faho committed May 28, 2020
    Configuration menu
    Copy the full SHA
    ce9be1a View commit details
    Browse the repository at this point in the history

  3. CHANGELOG: Fix some rst conversion leftovers 

    Apparently pandoc likes using `~~~` for sections, but sphinx does not.
    @faho
    faho committed May 28, 2020
    Configuration menu
    Copy the full SHA
    7946065 View commit details
    Browse the repository at this point in the history

  4. Add CHANGELOG to the docs 

    This uses a cheesy trampoline file, but it seems to work alright.
    @faho
    faho committed May 28, 2020
    Configuration menu
    Copy the full SHA
    f512bd1 View commit details
    Browse the repository at this point in the history