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

DOC: Loading sphinxcontrib.spelling to sphinx only if it's available (#21396) #21397

Merged
merged 1 commit into from
Jun 12, 2018
Merged

DOC: Loading sphinxcontrib.spelling to sphinx only if it's available (#21396) #21397

merged 1 commit into from
Jun 12, 2018

Conversation

datapythonista
Copy link
Member

@datapythonista datapythonista commented Jun 8, 2018

I think the optional dependencies go directly into the .txt files for pip and conda, and not into the yaml file. Please correct me if I'm wrong.

Seems like besides sphinxcontrib-spelling, a binary program enchant is required, and it's not available in conda for what I've seen. Not sure what's the right approach for it.

@gfyoung gfyoung added Bug Build Library building on various platforms Docs labels Jun 8, 2018
@gfyoung
Copy link
Member

gfyoung commented Jun 8, 2018

I think the optional dependencies go directly into the .txt files for pip and conda, and not into the yaml file. Please correct me if I'm wrong.

Good call: I agree that it is an optional dependency. You don't need it to install pandas for general use.

@@ -20,6 +20,7 @@ pytest-xdist
s3fs
scipy
seaborn
sphinxcontrib-spelling
Copy link
Contributor

Choose a reason for hiding this comment

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

these should go in requirements_dev.txt instead (only)

@@ -9,3 +9,4 @@ python-dateutil>=2.5.0
pytz
setuptools>=24.2.0
sphinx
sphinxcontrib-spelling
Copy link
Member

Choose a reason for hiding this comment

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

this file indicates it is autogenerated

@jorisvandenbossche
Copy link
Member

As said on the issue, given the installation troubles, I would make this an optional one.

@datapythonista datapythonista changed the title DOC: Adding missing dependency sphinxcontrib-spelling (#21396) DOC: Loading sphinxcontrib.spelling to sphinx only if it's available (#21396) Jun 11, 2018
Copy link
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

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

Apart from the comment where to put the dep, looks good to me!

@@ -13,3 +13,4 @@ dependencies:
- pytz
- setuptools>=24.2.0
- sphinx
- sphinxcontrib-spelling
Copy link
Member

Choose a reason for hiding this comment

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

I think we should rather put it in the requirements-pip/conda-optional.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.

@jreback, you said it should be in requirements_dev.txt, may be you want to explain why? I also thought the optional files made more sense, but you two surely know better than me.

Copy link
Contributor

Choose a reason for hiding this comment

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

requirements_dev are for pure dev things
but i think things have gotten confused

Copy link
Member

Choose a reason for hiding this comment

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

OK, let's discuss that in another one then

@jorisvandenbossche jorisvandenbossche merged commit 2e3f4ec into pandas-dev:master Jun 12, 2018
@jorisvandenbossche jorisvandenbossche added this to the 0.24.0 milestone Jun 12, 2018
@kylebarron
Copy link
Contributor

Just FYI, I just followed the instructions to create a development environment with Conda. On the python -m pip install -e . step, I got

sphinxcontrib-spelling 4.1.0 requires PyEnchant>=1.6.5, which is not installed.

Is that desired behavior or should the environment.yml file also include PyEnchant as a dependency?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Build Library building on various platforms Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing dependency for sphinxcontrib-spelling
5 participants