From 081348cfff8154ae93af725c84728e130c106d10 Mon Sep 17 00:00:00 2001 From: Kura Date: Fri, 8 Aug 2014 15:27:23 +0100 Subject: [PATCH] Added FAQs --- docs/source/faq.rst | 24 ++++++++++++++++++++++++ docs/source/index.rst | 8 ++++++++ 2 files changed, 32 insertions(+) diff --git a/docs/source/faq.rst b/docs/source/faq.rst index cde88d8..5690f9e 100644 --- a/docs/source/faq.rst +++ b/docs/source/faq.rst @@ -1,2 +1,26 @@ FAQ === + +Why is my `docs` url empty? +--------------------------- + +`docs_url` is only available when you're using `pythonhosted.org +`_. + +Why does my `docs` url have an extra slash? +------------------------------------------- + +This an issue with PyPI itself, it returns an additional slash inside +the URL to your pythonhosted docs. + +.. code-block:: python + + >>> yarg.get('yarg').docs + u'http://pythonhosted.org//yarg' + +Why is my `bugtracker` url empty? +--------------------------------- + +A: This does not seem to work when being set through setup.py, if you +go to your package on PyPI and click edit, one of the available fields +is called *bugtrack url*. diff --git a/docs/source/index.rst b/docs/source/index.rst index 3cef2fe..11fb275 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -43,3 +43,11 @@ Yarg documentation intro api + +Help +---- + +.. toctree:: + :maxdepth: 2 + + faq