Skip to content

DOC: Revise README to reStructuredText for PyPi #21

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.

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

Merged
merged 1 commit into from
Jul 23, 2015

Conversation

JDWarner
Copy link
Contributor

  • Convert from Markdown to reStructuredText for PyPi rendering
  • Remove part of the initial blurb pertaining to the SciPy talk
  • Add minimal installation instructions including matplotlib dependency
    • Remove NumPy dependency in setup.py
  • Use GitHub's cloud hosting to show expected result of example code in the README without expanding package size

You can view the result of these changes on GitHub here: https://github.com/jdwarner/trendvis/tree/readme_rst

Example 1
ex0

Example 2
ex1

Example 3
(snipped, see below)

twin0, yvals+0.075, yvals-0.1, edgecolor='none', color='darkorange')

# Automatically sets twinned axis colors
ex2.autocolor_spines()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You cut off the remainder of the example. The end result looks like this:
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I accidentally the whole ending. On it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed! Data looks a little different thanks to the pseudorandom set seed, otherwise formatting looks right to me.

@JDWarner JDWarner force-pushed the readme_rst branch 2 times, most recently from 187e3f3 to f4357a0 Compare July 23, 2015 19:57
@JDWarner
Copy link
Contributor Author

Corrected final example:
ex2

mscross added a commit that referenced this pull request Jul 23, 2015
DOC: Revise README to reStructuredText for PyPi
@mscross mscross merged commit 363e944 into matplotlib:master Jul 23, 2015
@mscross
Copy link
Contributor

mscross commented Jul 23, 2015

thank you!

@JDWarner JDWarner deleted the readme_rst branch July 23, 2015 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants