-
-
Notifications
You must be signed in to change notification settings - Fork 18.6k
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
DOC: update sphinx requirements for doc building #13532
Conversation
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. |
We could change the suggestions of |
docker is way too heavyweight for anything like this |
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) |
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 |
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. |
Current coverage is 84.33%@@ 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
|
d30cc3f
to
c0d87d8
Compare
@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. |
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?