Unable to build rtems-docs Was: Re: [PATCH] Update RMS documentation for overrun handling

Tue Jan 17 15:44:40 UTC 2017

On 17 January 2017 at 15:39, Joel Sherrill <joel at rtems.org> wrote:

>
>
> On Tue, Jan 17, 2017 at 9:30 AM, Gedare Bloom <gedare at rtems.org> wrote:
>
>> On Fri, Jan 13, 2017 at 5:51 PM, Chris Johns <chrisj at rtems.org> wrote:
>> > On 14/1/17 8:21 am, Gedare Bloom wrote:
>> >> I was unable to compile rtems-docs (cleanly), so I have not committed
>> >> this patch yet.
>> >
>> > What is the problem?
>> >
>>
>> It appears to be a problem in my distribution's texlive / latex
>> support I guess. I'm on an aging Ubuntu here. :)
>>
>> I don't recall my exact failure on CentOS and Fedora but it turned out
> that
> they didn't package the complete TexLive contents. I ended up removing
> what came with the distribution and using the TexLive master distribution.
>
> The README.txt file has details.
>
> https://git.rtems.org/rtems-docs/tree/README.txt
>
> I can now build the docs even on CentOS 6 which is as old a distribution
> as anyone should be made to use. :)
>
>
>
>> $ uname -a
>> Linux gedare-pc 3.13.0-24-generic #47-Ubuntu SMP Fri May 2 23:30:00
>> UTC 2014 x86_64 x86_64 x86_64 GNU/Linux
>>
>> $ sphinx-build --version
>> Sphinx (sphinx-build) 1.5.1
>>
>> $ python --version
>> Python 2.7.6
>>
>> Relevant-seeming shell output below:
>>
>> [ 24/101] Processing
>> /home/gedare/work/rtems/rtems-docs/build/c-user/html/index.html:
>> c-user/barrier_manager.rst c-user/board_support_packages.rst
>> c-user/chains.rst c-user/clock_manager.rst
>> c-user/configuring_a_system.rst c-user/constant_bandwidth_server.rst
>> c-user/cpu_usage_statistics.rst c-user/directive_status_codes.rst
>> c-user/dual_ports_memory_manager.rst c-user/event_manager.rst
>> c-user/example_application.rst c-user/fatal_error.rst
>> c-user/glossary.rst c-user/index.rst c-user/initialization.rst
>> c-user/interrupt_manager.rst c-user/io_manager.rst
>> c-user/key_concepts.rst c-user/linker_sets.rst
>> c-user/message_manager.rst c-user/multiprocessing.rst
>> c-user/object_services.rst c-user/overview.rst
>> c-user/partition_manager.rst c-user/pci_library.rst c-user/preface.rst
>> c-user/rate_monotonic_manager.rst c-user/red_black_trees.rst
>> c-user/region_manager.rst c-user/rtems_data_types.rst
>> c-user/scheduling_concepts.rst c-user/semaphore_manager.rst
>> c-user/signal_manager.rst c-user/stack_bounds_checker.rst
>> c-user/symmetric_multiprocessing_services.rst c-user/task_manager.rst
>> c-user/timer_manager.rst c-user/timespec_helpers.rst
>> c-user/user_extensions.rst -> build/c-user/html/index.html
>> 16:19:18 runner ' /usr/local/bin/sphinx-build -Q -b html -c . -d
>> /home/gedare/work/rtems/rtems-docs/build/c-user/doctrees/html .
>> /home/gedare/work/rtems/rtems-docs/build/c-user/html '
>> /usr/local/lib/python2.7/dist-packages/sphinx/util/requests.py:33:
>> UserWarning: Some links may return broken results due to being unable
>> to check the Server Name Indication (SNI) in the returned SSL cert
>> against the hostname in the url requested. Recommended to install
>> "requests[security]" as a dependency or upgrade to a python version
>> with SNI support (Python 3 and Python 2.7.9+).
>>   'Some links may return broken results due to being unable to '
>>
>> Exception occurred:
>>   File "/usr/local/lib/python2.7/dist-packages/sphinx/writers/latex.py",
>> line 366, in __init__
>>     self.sectionnames.index(builder.config.latex_toplevel_sectioning)
>> ValueError: 'parts' is not in list
>> The full traceback has been saved in /tmp/sphinx-err-sQHg09.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://github.com/sphinx-doc/sphinx/issues>. Thanks!
>>
>> Above warning and exception repeat 3 more times.
>>
>

I've seen this issue, it was caused by latex_use_parts and was causing
sphinx to crash.
It has been fixed by
https://github.com/sphinx-doc/sphinx/commit/12096b3b863f40d10fce94e03abc4b8d3f856eb1
thus, I would either try to update sphinx, or if you feel brave enough you
could manually patch sphinx, which should theoretically fix this issue too.

Traceback from /tmp/sphinx-err-sQHg09.log
>>
>> Traceback (most recent call last):
>>   File "/usr/local/lib/python2.7/dist-packages/sphinx/cmdline.py",
>> line 296, in main
>>     app.build(opts.force_all, filenames)
>>   File "/usr/local/lib/python2.7/dist-packages/sphinx/application.py",
>> line 333, in build
>>     self.builder.build_update()
>>   File "/usr/local/lib/python2.7/dist-packages/sphinx/builders/__
>> init__.py",
>> line 246, in build_update
>>     self.build(['__all__'], to_build)
>>   File "/usr/local/lib/python2.7/dist-packages/sphinx/builders/__
>> init__.py",
>> line 322, in build
>>     self.write(docnames, list(updated_docnames), method)
>>   File "/usr/local/lib/python2.7/dist-packages/sphinx/builders/latex.py",
>> line 130, in write
>>     docwriter.write(doctree, destination)
>>   File "/usr/local/lib/python2.7/dist-packages/docutils/writers/__
>> init__.py",
>> line 80, in write
>>     self.translate()
>>   File "/usr/local/lib/python2.7/dist-packages/sphinx/writers/latex.py",
>> line 159, in translate
>>     visitor = self.translator_class(self.document, self.builder)
>>   File "/usr/local/lib/python2.7/dist-packages/sphinx/writers/latex.py",
>> line 366, in __init__
>>     self.sectionnames.index(builder.config.latex_toplevel_sectioning)
>> ValueError: 'parts' is not in list
>> _______________________________________________
>> devel mailing list
>> devel at rtems.org
>> http://lists.rtems.org/mailman/listinfo/devel
>>
>
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/devel/attachments/20170117/5fbe31e9/attachment-0002.html>