Skip to content

Commit

Permalink
Fix Broken CLI docs (#5148)
Browse files Browse the repository at this point in the history
* Fix building CLI docs

* Fix contributing docs

   Double colon before block directive is wrong.
  • Loading branch information
oz123 authored Jun 27, 2022
1 parent 25caf62 commit fb0f888
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

click.Command = pipenv.vendor.click.Command
click.Group = pipenv.vendor.click.Group

click.BaseCommand = pipenv.vendor.click.BaseCommand
# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
Expand Down
3 changes: 2 additions & 1 deletion docs/dev/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -282,9 +282,10 @@ $ docker run --rm -v $(pwd):/usr/src -it python:3.7 bash

It is important that your environment is setup correctly, and
this may take some work, for example, on a specific Mac installation, the following
steps may be needed::
steps may be needed:

.. code-block:: bash
# Make sure the tests can access github
if [ "$SSH_AGENT_PID" = "" ]
then
Expand Down

0 comments on commit fb0f888

Please sign in to comment.