Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

man page invalid formatting #78

Closed
2 tasks
hemna opened this issue Apr 15, 2019 · 4 comments · Fixed by #89
Closed
2 tasks

man page invalid formatting #78

hemna opened this issue Apr 15, 2019 · 4 comments · Fixed by #89
Labels
Milestone

Comments

@hemna
Copy link

hemna commented Apr 15, 2019

When building the manpage with a long help description I get a broken output

  • You can see the broken DESCRIPTION ===========[ENDL(2)],[.....
  • You can see below that the spacing is very tall between the arguments.
SOCOK8S(1)                                                                             SOCOK8S(1)



NAME
       socok8s  -  This  script is blah blah blah blah

SYNOPSIS
       socok8s  [--quiet] [--pre] [--version] [--help] [<command>]

       DESCRIPTION ===========[_ENDL_(2)],[This is a longer description that  should  get  filled
       in.],[]

       <More elaborate description goes here>.

ARGUMENTS
       -q, --quiet
              suppress noisy output.  [Default: off]



       -p, --pre
              Run preflight only.  [Default: off]



       -v, --version
              Prints version.



       -h, --help
              Prints help.
@matejak matejak added the bug label Apr 16, 2019
@matejak matejak added this to the 2.8.1 milestone Apr 16, 2019
@matejak
Copy link
Owner

matejak commented Apr 17, 2019

The broken description is a clear one, but the spacing is strange. Could you also share the reSt source?

@hemna
Copy link
Author

hemna commented Apr 17, 2019

└─[$] <git:(argbash*)> cat socok8s.rst

.. include:: socok8s-defs.rst


=======
socok8s
=======

------------------------------------------------------------------------------------------------
This script is used to bootstrap the socok8s dev env. To build the documentation, run tox -edocs
------------------------------------------------------------------------------------------------

:Author: |AUTHOR|
:Date:   2019-04-17
:Version: |VERSION|
:Manual section: |MAN_SECTION|


SYNOPSIS
========

``socok8s  [--quiet] [--pre] [--version] [--help] [<command>]``


DESCRIPTION
===========[_ENDL_(2)],[This is a longer description that should get filled in.],[]

|DESCRIPTION|


ARGUMENTS
=========

-q, --quiet    suppress noisy output.
               [Default: off]

               |OPTION_QUIET|

-p, --pre      Run preflight only.
               [Default: off]

               |OPTION_PRE|

-v, --version  Prints version.

               |OPTION_VERSION|

-h, --help     Prints help.

               |OPTION_HELP|

@hemna
Copy link
Author

hemna commented Apr 17, 2019

└─[$] <git:(argbash*)> cat socok8s-defs.rst

.. |AUTHOR| replace:: <Your name goes here>

.. |VERSION| replace:: \

.. |MAN_SECTION| replace:: 1

.. |DESCRIPTION| replace::
   <More elaborate description
   goes here>.

.. |OPTION_QUIET| replace:: \

.. |OPTION_PRE| replace:: \

.. |OPTION_VERSION| replace:: \

.. |OPTION_HELP| replace:: \

@matejak
Copy link
Owner

matejak commented May 12, 2019

I have checked your example, and the manpage spacing looks fine. I suppose that the problem may have been caused by the first item that could somehow confuse rst2man.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants