Pip: A sub paragraph in pip install docs in not rendering correctly

[deveshks]

The section of docs in VCS support section of pip install starting from So if your repository layout is: is not being rendered correctly.

There are extra line breaks the bullet points, and the last sentence has too much spacing between words.

The browser used was Chrome: Version 80.0.3987.149 (Official Build) (64-bit)

[uranusjr]

This is kind of rendering “correctly” technically, just not very pretty. I wonder if it would help to insert a <wbr> or something before the inline code block.

[McSinyx]

The formatting of the bullet list is actually ill-formed: e2c9a0f7431f050881f792ca67daa668adfef5e9

A better one could be either

So if your repository layout is:

- pkg_dir/

   - setup.py  # setup.py for package ``pkg``
   - some_module.py

- other_dir/

   - some_file

- some_other_file

or

So if your repository layout is::

   pkg_dir
   ├── setup.py  # setup.py for package "pkg"
   └── some_module.py
   other_dir
   └── some_file
   some_other_file

I can't reproduce the last line spacing issue though, maybe it's a browser-specific thing? I use Firefox BTW.

[uranusjr]

It’s probably a good idea to convert the list into a code block (similar to the tree command output). The packaging tutorial also does something similar.

[deveshks]

I just had a look at https://pip.pypa.io/en/latest/reference/pip_install/#vcs-support to see how the rendering of the package tree looks like, but still doesn't look very pretty and well aligned, or maybe I am looking into it too much.

[McSinyx]

Something might be wrong with your font, but Python's doc convention using spaces may be more portable.

[deveshks]

Agreed @McSinyx , so something like the following might be a better idea

.. code-block:: text

pkg_dir/
    setup.py
   some_module.py
other_dir/
    some_file   
some_other_file

Hi @uranusjr , @pradyunsg ,

If following seems a better approach than the tree structure, can I make a PR for the same?