PyPI, reStructuredText and readthedocs problems
Leonardo Giordani
giordani.leonardo at gmail.com
Mon Mar 2 06:47:07 EST 2015
The libev problem happens on my local Ubuntu 14.10 too. It is not a pike
requirement however (not installed by 'pip install pika').
Seems that pika forces some requirements when on readthedocs through this
code
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
requirements = list()
if on_rtd:
requirements.append('tornado')
requirements.append('twisted')
requirements.append('pyev')
I contacted Gavin Roy, the pika maintainer, to check this with him.
Thanks
Leonardo Giordani
@tw_lgiordani <http://twitter.com/tw_lgiordani> - lgiordani.com
My profile on About.me <http://about.me/leonardo.giordani> - My GitHub page
<https://github.com/lgiordani>
2015-03-02 12:43 GMT+01:00 Leonardo Giordani <giordani.leonardo at gmail.com>:
> Sorry, seems that GMail cannot understand I'm on a ML, and just answered
> the single persons.
>
> [Thread with INADA]
> Thank you.
>
> Seems that rst2html.py uses the header of a section as the id of the
> corresponding HTML anchor.
> Since I had two headers with the same title there was a name clash.
> I just changed one of the headers and the problem is gone.
>
>
> [Thread with Wolfgang]
> On 03/02/2015 12:11 PM, Leonardo Giordani wrote:
>
>> Thanks, spotted!
>>
>> Now readthedocs fails with this message
>>
>> Traceback (most recent call last):
>> File "/home/docs/checkouts/
>> readthedocs.org/user_builds/postage/envs/feature-docs/local/lib/python2.7/site-packages/sphinx/cmdline.py
>> <
>> http://readthedocs.org/user_builds/postage/envs/feature-docs/local/lib/python2.7/site-packages/sphinx/cmdline.py>",
>> line 253, in main
>> warningiserror, tags, verbosity, parallel)
>> File "/home/docs/checkouts/
>> readthedocs.org/user_builds/postage/envs/feature-docs/local/lib/python2.7/site-packages/sphinx/application.py
>> <
>> http://readthedocs.org/user_builds/postage/envs/feature-docs/local/lib/python2.7/site-packages/sphinx/application.py>",
>> line 107, in __init__
>> confoverrides or {}, self.tags)
>> File "/home/docs/checkouts/
>> readthedocs.org/user_builds/postage/envs/feature-docs/local/lib/python2.7/site-packages/sphinx/config.py
>> <
>> http://readthedocs.org/user_builds/postage/envs/feature-docs/local/lib/python2.7/site-packages/sphinx/config.py>",
>> line 229, in __init__
>> execfile_(filename, config)
>> File "/home/docs/checkouts/
>> readthedocs.org/user_builds/postage/envs/feature-docs/local/lib/python2.7/site-packages/sphinx/util/pycompat.py
>> <
>> http://readthedocs.org/user_builds/postage/envs/feature-docs/local/lib/python2.7/site-packages/sphinx/util/pycompat.py>",
>> line 105, in execfile_
>> exec code in _globals
>> File "conf.py", line 31, in <module>
>> import postage
>> File "/home/docs/checkouts/
>> readthedocs.org/user_builds/postage/checkouts/feature-docs/postage/__init__.py
>> <
>> http://readthedocs.org/user_builds/postage/checkouts/feature-docs/postage/__init__.py>",
>> line 10, in <module>
>> from postage import messaging
>> File "/home/docs/checkouts/
>> readthedocs.org/user_builds/postage/checkouts/feature-docs/postage/messaging.py
>> <
>> http://readthedocs.org/user_builds/postage/checkouts/feature-docs/postage/messaging.py>",
>> line 4, in <module>
>> import pika
>> ImportError: No module named pika
>>
>> Exception occurred:
>> File "/home/docs/checkouts/
>> readthedocs.org/user_builds/postage/checkouts/feature-docs/postage/messaging.py
>> <
>> http://readthedocs.org/user_builds/postage/checkouts/feature-docs/postage/messaging.py>",
>> line 4, in <module>
>> import pika
>> ImportError: No module named pika
>> The full traceback has been saved in /tmp/sphinx-err-R4ZC2D.log, if you
>> want to report the issue to the developers.
>> Please also report this if it was a user error, so that a better error
>> message can be provided next time.
>> A bug report can be filed in the tracker at <
>> https://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!
>>
>> I however configured the build to use a virtualenv and specified 'pika'
>> in my requirements.txt file.
>>
>>
> Look at the complete output from readthedocs:
>
> Setup Output
>
>
>
> checkout
> -----
>
>
>
> venv
> -----
>
> Using real prefix '/usr'
> New python executable in /home/docs/checkouts/
> readthedocs.org/user_builds/postage/envs/latest/bin/python
> Installing setuptools, pip...done.
> Running virtualenv with interpreter /home/docs/bin/python
>
>
> doc_builder
> -----
>
> Requirement already up-to-date: sphinx==1.2.2 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> Requirement already up-to-date: virtualenv==1.10.1 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> Requirement already up-to-date: setuptools==1.1 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> Requirement already up-to-date: docutils==0.11 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> Requirement already up-to-date: mkdocs==0.11.1 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> Requirement already up-to-date: mock==1.0.1 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> Requirement already up-to-date: pillow==2.6.1 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> Requirement already up-to-date: readthedocs-sphinx-ext==0.4.4 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> Requirement already up-to-date: Jinja2>=2.7.1 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> (from mkdocs==0.11.1)
> Requirement already up-to-date: Markdown>=2.3.1,<2.5 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> (from mkdocs==0.11.1)
> Requirement already up-to-date: PyYAML>=3.10 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> (from mkdocs==0.11.1)
> Requirement already up-to-date: watchdog>=0.7.0 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> (from mkdocs==0.11.1)
> Requirement already up-to-date: ghp-import>=0.4.1 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> (from mkdocs==0.11.1)
> Requirement already up-to-date: argh>=0.24.1 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> (from watchdog>=0.7.0->mkdocs==0.11.1)
> Requirement already up-to-date: pathtools>=0.1.1 in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> (from watchdog>=0.7.0->mkdocs==0.11.1)
> Cleaning up...
>
>
> requirements
> -----
>
> Requirement already satisfied (use --upgrade to upgrade): mock in
> /var/build/user_builds/postage/envs/latest/lib/python2.7/site-packages
> (from -r requirements.txt (line 1))
> Downloading/unpacking pika (from -r requirements.txt (line 2))
> Running setup.py
> (path:/var/build/user_builds/postage/envs/latest/build/pika/setup.py)
> egg_info for package pika
>
> Downloading/unpacking tornado (from pika->-r requirements.txt (line 2))
> Running setup.py
> (path:/var/build/user_builds/postage/envs/latest/build/tornado/setup.py)
> egg_info for package tornado
>
> Downloading/unpacking twisted (from pika->-r requirements.txt (line 2))
> Running setup.py
> (path:/var/build/user_builds/postage/envs/latest/build/twisted/setup.py)
> egg_info for package twisted
>
> Downloading/unpacking pyev (from pika->-r requirements.txt (line 2))
> Running setup.py
> (path:/var/build/user_builds/postage/envs/latest/build/pyev/setup.py)
> egg_info for package pyev
> Aborted: pyev-0.9.0 requires libev >= 4.15
> Complete output from command python setup.py egg_info:
> Aborted: pyev-0.9.0 requires libev >= 4.15
>
> There it is! readthedocs already failed to install pika because it, in
> turn, requires libev >= 4.15 .
>
>
>
>
> Leonardo Giordani
> @tw_lgiordani <http://twitter.com/tw_lgiordani> - lgiordani.com
> My profile on About.me <http://about.me/leonardo.giordani> - My GitHub
> page <https://github.com/lgiordani>
>
> 2015-03-02 11:33 GMT+01:00 INADA Naoki <songofacandy at gmail.com>:
>
>> PyPI parses your README strictly.
>>
>> $ rst2html.py --strict README.rst
>> README.rst:700: (INFO/1) Duplicate implicit target name: "fingerprint".
>> Exiting due to level-1 (INFO) system message.
>>
>> But I don't know how to avoid this error when converting from markdown.
>>
>> On Mon, Mar 2, 2015 at 6:35 PM Leonardo Giordani <
>> giordani.leonardo at gmail.com> wrote:
>>
>>> Hi all,
>>>
>>> Some time ago I open sourced a package named postage (
>>> https://pypi.python.org/pypi/postage/).
>>>
>>> I am experiencing issues with documentation. The project is hosted on
>>> GitHub (https://github.com/lgiordani/postage), where the README.md is
>>> perfectly rendered. My issues are:
>>>
>>> 1. I use pandoc to convert README.md to README.rst. This latter is
>>> rendered by GitHUb as well, but when I upload the package to PyPI I get a
>>> messy result (look at the package page).
>>>
>>> 2. When I import the project into readthedocs.org the build fails with
>>> no output. This is the only information I get
>>>
>>> ----------------------------- 8< -----------------------------
>>>
>>> Build for postage
>>>
>>> Built: Feb. 27, 2015. 10:41 a.m.
>>>
>>> State: Finished
>>>
>>> Outcome: Failed (Status Code: 0)
>>>
>>> Version: latest
>>>
>>> Type: html
>>>
>>> Build Standard Output
>>>
>>> ----------------------------- 8< -----------------------------
>>>
>>> May someone help me figuring out what's wrong in my code?
>>> Thanks!
>>>
>>> Leo
>>>
>>>
>>> Leonardo Giordani
>>> @tw_lgiordani <http://twitter.com/tw_lgiordani> - lgiordani.com
>>> My profile on About.me <http://about.me/leonardo.giordani> - My GitHub
>>> page <https://github.com/lgiordani>
>>> --
>>> https://mail.python.org/mailman/listinfo/python-list
>>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-list/attachments/20150302/1ac6fae7/attachment.html>
More information about the Python-list
mailing list