Add note about the broken docs problem.

This commit is contained in:
Jason R. Coombs 2016-11-04 10:16:12 -04:00
parent 4ee40ca2d1
commit 18cb65f8f1

View File

@ -8,6 +8,20 @@
.. image:: https://img.shields.io/travis/jaraco/skeleton/master.svg .. image:: https://img.shields.io/travis/jaraco/skeleton/master.svg
:target: http://travis-ci.org/jaraco/skeleton :target: http://travis-ci.org/jaraco/skeleton
License
=======
License is indicated in the project metadata (typically one or more License is indicated in the project metadata (typically one or more
of the Trove classifiers). For more details, see `this explanation of the Trove classifiers). For more details, see `this explanation
<https://github.com/jaraco/skeleton/issues/1>`_. <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.