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.

Sign up for GitHub

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

Fix Broken CLI docs #5148

Merged
merged 2 commits into from
Jun 27, 2022
Merged

Fix Broken CLI docs #5148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7905c9
Fix building CLI docs
oz123 Jun 26, 2022
b12e197
Fix contributing docs
oz123 Jun 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
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
View file
Open in desktop
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