summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2016-11-04 10:16:12 -0400
committerJason R. Coombs <jaraco@jaraco.com>2016-11-04 10:16:12 -0400
commit18cb65f8f1c1eaf7b79a33fb5a2b7cbd1f851868 (patch)
tree2c8db266ddab625d37c875b641aec0a8a84dec50
parent4ee40ca2d13c2c8b544ad5f880193f5c0864648a (diff)
downloadpytest-runner-18cb65f8f1c1eaf7b79a33fb5a2b7cbd1f851868.tar.gz
Add note about the broken docs problem.
-rw-r--r--README.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index bb3d912..5196a10 100644
--- a/README.rst
+++ b/README.rst
@@ -8,6 +8,20 @@
.. image:: https://img.shields.io/travis/jaraco/skeleton/master.svg
:target: http://travis-ci.org/jaraco/skeleton
+
+License
+=======
+
License is indicated in the project metadata (typically one or more
of the Trove classifiers). For more details, see `this explanation
<https://github.com/jaraco/skeleton/issues/1>`_.
+
+Docs
+====
+
+There's `no good mechanism for publishing documentation
+<https://github.com/pypa/python-packaging-user-guide/pull/266>`_
+easily. If there's a documentation link above, it's probably
+stale because PyPI-based documentation is deprecated. This
+project may have documentation published at ReadTheDocs, but
+probably not. Good luck finding it.