Move sample.py out of the distribution

[briancurtin]

sample.py can live inside the docs directory and work fine without being installed. This may require a change on the ReadTheDocs configuration to point it at the included docs-requirements.txt file, though I won't know that until this gets merged and built on RTD. Including it now in case it's needed.

[briancurtin]

@eli-schwartz, this probably solves the sample problem, right?

[codecov-io]

Codecov Report

:exclamation: No coverage uploaded for pull request base (master@3d08098). Click here to learn what that means. The diff coverage is n/a.

@@           Coverage Diff           @@
##             master    #29   +/-   ##
=======================================
  Coverage          ?   100%           
=======================================
  Files             ?      1           
  Lines             ?     83           
  Branches          ?     16           
=======================================
  Hits              ?     83           
  Misses            ?      0           
  Partials          ?      0

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3d08098...579fa9d. Read the comment docs.

[briancurtin]

FWIW, this works locally in that the sample is no longer included in the build, and the docs properly include the sample, so I think it's probably the right move.

[eli-schwartz]

That would solve the sample problem, sure.

Does readthedocs have some way to test the documentation build without pushing a release?

[briancurtin]

Not currently, but there’s recent activity on https://github.com/rtfd/readthedocs.org/issues/1340 to suggest that may be possible in the future. For now, once I merge this I’ll keep an eye on the RTD build and if it needs a follow up change I’ll do that separately.

[eli-schwartz]

Actually https://docs.readthedocs.io/en/latest/features.html#version-control-support-matrix implies you should be able to manually enable RTD for a specific branch, as long as the branch is in the primary repository (which this, of course, is).

Could test the docs build, and then test removing install_requires, before merging to master if I read this right.

[briancurtin]

https://deprecation.readthedocs.io/en/fix_sample_installation/ shows this works.

What's the install_requires change you mention? I'm guessing you mean to take unittest2 out of it?

[eli-schwartz]

Yes.

[briancurtin]

This is now released as 2.0.4: https://pypi.org/project/deprecation/2.0.4/

[eli-schwartz]

Thanks!

[eli-schwartz]

BTW have you pushed the git tag for this release yet.

[briancurtin]

Oops, forgot to push. It's there now.