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

Address some doc nits #878

Merged
merged 3 commits into from Jun 20, 2020
Merged

Address some doc nits #878

merged 3 commits into from Jun 20, 2020

Commits on Jun 20, 2020

  1. README: Use literal block for install command 

    We need to precede things with '::' for them to render correctly.

A typo is corrected.

Signed-off-by: Stephen Finucane <stephen@that.guru>
    @stephenfin @akrabat
    stephenfin authored and akrabat committed Jun 20, 2020
    Configuration menu
    Copy the full SHA
    c9b5d51 View commit details
    Browse the repository at this point in the history

  2. doc: Remove unicode prefixes 

    rst2pdf only supports Python 3 now, which means the unicode string
prefix is unnecessary - strings are unicode by default in Python 3.

We also fix some formatting so people copy-pasting the configuration
into 'conf.py' files won't have to immediately resolve PEP8 issues.

Signed-off-by: Stephen Finucane <stephen@that.guru>
    @stephenfin @akrabat
    stephenfin authored and akrabat committed Jun 20, 2020
    Configuration menu
    Copy the full SHA
    67788ee View commit details
    Browse the repository at this point in the history

  3. README: Add quick intro to Sphinx 

    Mention support for Sphinx by way of a quick intro. People seeking more
information can refer to the manual.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: rst2pdf#535
    @stephenfin @akrabat
    stephenfin authored and akrabat committed Jun 20, 2020
    Configuration menu
    Copy the full SHA
    faef5eb View commit details
    Browse the repository at this point in the history