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

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

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

Conversation

janl
Copy link
Member

@janl janl commented Jan 18, 2023

Overview

Testing recommendations

Related Issues or Pull Requests

Checklist

  • Code is written and works correctly
  • Changes are covered by tests
  • Any new configurable parameters are documented in rel/overlay/etc/default.ini
  • Documentation changes were made in the src/docs folder
  • Documentation changes were backported (separated PR) to affected branches

Copy link
Contributor

@big-r81 big-r81 left a comment

Choose a reason for hiding this comment

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

+1

Comment on lines +129 to 135
pip3 install sphinx docutils pygments sphinx_rtd_theme

Copy link
Contributor

@nickva nickva Jan 18, 2023

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

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

Successfully merging this pull request may close these issues.

None yet

4 participants