(test) [ykarel@yatinkarel sahara]$ python setup.py build_sphinx -b man
running build_sphinx
[pbr] Writing ChangeLog
[pbr] Generating ChangeLog
[pbr] ChangeLog complete (0.1s)
[pbr] Generating AUTHORS
[pbr] AUTHORS complete (0.2s)
Running Sphinx v1.6.3
connecting events for openstackdocstheme
loading pickled environment... done
[oslo_config.sphinxconfiggen] reading config generator instructions from /home/ykarel/work/sahara/doc/source/config-generator.conf
[oslo_config.sphinxconfiggen] writing sample configuration to /home/ykarel/work/sahara/doc/source/sample.config
Using openstackdocstheme Sphinx theme from /home/ykarel/work/sahara/test/lib/python2.7/site-packages/openstackdocstheme/theme
building [mo]: all of 0 po files
building [man]: all source files
updating environment: 0 added, 2 changed, 0 removed
reading sources... [100%] user/features
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... sahara.1 { intro/index intro/overview intro/architecture install/index install/installation-guide install/dashboard-guide configuration/index configuration/sampleconfig user/index user/overview user/quickstart user/dashboard-user-guide user/features user/registering-image user/statuses user/sahara-on-ironic user/plugins user/vanilla-plugin user/ambari-plugin user/spark-plugin user/cdh-plugin user/mapr-plugin user/edp user/guest-requirements user/hadoop-swift user/vanilla-imagebuilder user/cdh-imagebuilder admin/index admin/configuration-guide admin/advanced-configuration-guide admin/upgrade-guide contributor/index contributor/development-guidelines contributor/development-environment contributor/dashboard-dev-environment-guide contributor/devstack contributor/how-to-participate contributor/how-to-build-oozie contributor/adding-database-migrations contributor/testing contributor/log-guidelines contributor/apiv2 contributor/image-gen contributor/launchpad contributor/gerrit contributor/jenkins reference/index reference/plugins reference/plugin-spi reference/edp-spi reference/restapi }
Warning, treated as error:
/home/ykarel/work/sahara/doc/source/user/features.rst::"table row spanning" not supported
If i create multiple rows(Plugin) and column(Features) in features.rst as below, it works:-
+--------------------------+---------+----------+----------+-------+
| | Plugin | | | |
+--------------------------+---------+----------+----------+-------+
| Feature | Vanilla | HDP | Cloudera | Spark |
+==========================+=========+==========+==========+=======+
This seems to be a limitation of the manpage renderer of sphinx, which does not support that header.
The suggested change introduces multiple cells where there shouldn't be, so it's not really a fix.
Possible solution:
- ignore it and tell the downstreams that generate the manpages to skip them for sahara
- rework the header so that the issue is workarounded.