"python setup.py build_sphinx -b man" not working
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Sahara |
Fix Released
|
Undecided
|
Unassigned |
Bug Description
(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.
[oslo_config.
Using openstackdocstheme Sphinx theme from /home/ykarel/
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/
Warning, treated as error:
/home/ykarel/
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.