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

chore(readme): update mac dev install instructions #4386

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore(readme): update mac dev install instructions #4386

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 8 additions & 5 deletions README-DEV.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,15 +120,18 @@ Unless you want to install the optional dependencies, skip to the next section.

Install what else we can with Homebrew::

brew install help2man gnupg md5sha1sum node python
brew install \
erlang \
elixir \
help2man \
node \
python \
spidermonkey

If you don't already have pip installed, install it::

sudo easy_install pip

Now, install the required Python packages::

sudo pip install sphinx docutils pygments sphinx_rtd_theme
pip3 install sphinx docutils pygments sphinx_rtd_theme

Comment on lines +134 to 135
Copy link
Contributor

@nickva nickva Jan 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, for docs for local dev just having python3 with pip is enough. We do most of the requirements in a venv anyway https://github.com/apache/couchdb/tree/main/src/docs https://github.com/apache/couchdb/blob/main/src/docs/requirements.txt

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right, but on homebrew python, pip doesn’t exist and instead there is pip3

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or are you suggesting that whole line can go? (suggested inline patches = <3 ;)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure even if Python needs to be installed via brew. The xcode-select --install command would add Python 3 and pip3, which are of versions 3.9.6 and 21.2.4 respectively at the moment (Ventura 13.1).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ran into issues with the built-in python

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can update the src/docs to use pip3. I probably just had pip linked to it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do y’all want me to do with this line?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge it. It looks good. I have PR for docs setup+readme to use pip3 instead of pip #4415

FreeBSD
~~~~~~~
Expand Down