Skip to content

DOC: update sphinx requirements for doc building #13532

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

Merged

Conversation

jorisvandenbossche
Copy link
Member

Simplified the version requirement for sphinx (>= 1.3.2). In principle >= 1.2.2 but < 1.3.0 also works, but left it out for simplicity.

@cswarth Do you have other things that you find unclear about the requirements for the doc build environment?

@jorisvandenbossche jorisvandenbossche added this to the 0.18.2 milestone Jun 29, 2016
@cswarth
Copy link
Contributor

cswarth commented Jun 29, 2016

I don't think clarity is the problem as much as being a relatively high barrier to entry for contributing to the docs. By the time you get done installing all the prerequisites and optional dependencies, it feels quite onerous. I used pip to install the optional dependencies as I ran across them, but often wished there were a requirements.txt (or more likely, Dockerfile) to establish a known working environment.

@TomAugspurger
Copy link
Contributor

We could change the suggestions of conda create -n pandas_dev python=3 --file ci/requirements_dev.txt to ci/requirements_all.txt

@jreback
Copy link
Contributor

jreback commented Jun 29, 2016

docker is way too heavyweight for anything like this

@jorisvandenbossche
Copy link
Member Author

We could change the suggestions of conda create -n pandas_dev python=3 --file ci/requirements_dev.txt to ci/requirements_all.txt

That is already mentioned in the section about creating a development environment (http://pandas-docs.github.io/pandas-docs-travis/contributing.html#creating-a-development-environment), but it would maybe made more prominent in the section on doc building requirements (instead of just linking to that section)

@cswarth
Copy link
Contributor

cswarth commented Jun 29, 2016

I only mentioned a dockerfile because I found there were extra-pythonic dependencies that were not captured by pip or conda. For instance, I couldn't install matplotlib unless I first ran apt-get install pkg-config and apt-get install libfreetype6-dev.

@jreback
Copy link
Contributor

jreback commented Jun 29, 2016

not true conda installs everything u need. if you are using pip then YOU do need to manage dependencies yourself. and that's why we don't use pip for anything.

@codecov-io
Copy link

codecov-io commented Jun 30, 2016

Current coverage is 84.33%

Merging #13532 into master will decrease coverage by <.01%

@@             master     #13532   diff @@
==========================================
  Files           138        138          
  Lines         51126      51111    -15   
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
- Hits          43122      43107    -15   
  Misses         8004       8004          
  Partials          0          0          

Powered by Codecov. Last updated by 8f8d75d...d30cc3f

@jorisvandenbossche
Copy link
Member Author

I only mentioned a dockerfile because I found there were extra-pythonic dependencies that were not captured by pip or conda.

@cswarth If you had problems installing matplotlib with conda, you can report it over there, but normally this should just work.

I personally think the instructions of how to set up a development environment are already quite elaborate, but improvements are always welcome!

I reworded the reference to first creating a dev environment for building the docs to make this more clear.

@jorisvandenbossche jorisvandenbossche merged commit 7c9ba14 into pandas-dev:master Jul 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants