Update doc build. #8536
Update doc build. #8536
Conversation
35a64ba to
a4e82e9
Compare
|
Some of this is covered in #8525, I think. |
|
Oh, I see that they're skipped there; this might be a better choice. @choldgraf |
|
@QuLogic I agree! I didn't wanna complicate that PR any more than necessary so instead of adding the scipy dependency I skipped the examples and was gonna open an issue. Looks like you're one step in front of me :) |
| @@ -134,7 +120,7 @@ | |||
| project = 'Matplotlib' | |||
| copyright = ('2002 - 2012 John Hunter, Darren Dale, Eric Firing, ' | |||
| 'Michael Droettboom and the Matplotlib development ' | |||
| 'team; 2012 - 2016 The Matplotlib development team') | |||
| 'team; 2012 - 2017 The Matplotlib development team') | |||
There was a problem hiding this comment.
maybe overkill but we could always use
"...2012 - %s The Matplotlib development team" % day.year
There was a problem hiding this comment.
Somehow automatically generating copyright years feels wrong to me...
There was a problem hiding this comment.
hehe fair enough, just a thought :)
There was a problem hiding this comment.
I can imagine in 3 years someone would realize it's showing "2012 - NULL_VALUE" or something
| except ImportError: | ||
| raise ImportError("No module named mock - you need to install " | ||
| "mock to build the documentation") | ||
| from mock import MagicMock |
There was a problem hiding this comment.
Should mock now be in the list of dependencies on L43?
There was a problem hiding this comment.
unittest.mock is part of the stdlib in py3.3+; we check for mock for py2.
doc/make.py
Outdated
| @@ -309,5 +309,5 @@ def build_all(): | |||
| ' are %s' % (command, funcd.keys()))) | |||
| func() | |||
| else: | |||
| all() | |||
| raise SystemExit("Missing target.") | |||
There was a problem hiding this comment.
What does this mean/when is it thrown?
There was a problem hiding this comment.
"You ran ./make.py instead of ./make.py html or ./make.py pdf or ./make.py $whatevertarget" (cf https://grox.net/doc/unix/unix_shell_humor.html).
There was a problem hiding this comment.
this should be clarified in this case...something like "You must supply a target after make.py"
- Add copied depsy_badge to gitignore. - In conf.py, move all dependency checks together. - In conf.py and doc-requirements.txt, added dependency on scipy (for animation/bayes_update.py, animation/double_pendulum_animated.py). - In conf.py, update copyright years. - Fix error when invoking make.py without a target.
a4e82e9 to
c19c3ed
Compare
|
This reminds me - I had ran into issues getting the documentation to build and I opened an issue about it a while back: I don't think that changing the documentation contribution guidelines is w/in the scope of this PR, but do you have any idea as to the two dependency problems I ran into? They were for:
|
|
graphviz ("dot") is now documented as a dependency. |
|
haha fair enough - I just checked the dev docs and you're right, that's in there now! ok cool disregard my comment then :) |
|
ah - though it looks like graphviz is not in the |
|
it's a binary, not pip installable |
|
huh - I just installed |
|
It's a thin Python wrapper which is useless for our purposes. |
|
I'll update the dev docs to reflect this fact. This is the kind of stuff that a new user will end up wasting an hour trying to figure out so it needs to be documented. |
PR Summary
animation/bayes_update.py, animation/double_pendulum_animated.py).