Skip to content

Document the documentation build requirements (closes #8174) #8191

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

Closed
wants to merge 3 commits into from
Closed

Document the documentation build requirements (closes #8174) #8191

wants to merge 3 commits into from

Conversation

vidursatija
Copy link
Contributor

Only the file is edited and not build using Sphinx

Only the file is edited and not build using Sphinx
@phobson phobson changed the title Updating file as per #8174 Document the documentation build requirements (closes #8174) Mar 4, 2017
Sphinx_ documentation generation tool. Sphinx-1.0 or later and numpydoc 0.4 or
later is required.
Sphinx_ documentation generation tool.
The requirements are as follows (https://github.com/matplotlib/matplotlib/blob/master/doc-requirements.txt)
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 you need a blank line before the start if the list for it to be properly formatted when it's rendered to HTML

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure. I'll do the needful

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I changed it. Now it looks like a proper list. Sorry for any inconvenience caused

@vidursatija
Copy link
Contributor Author

Please pull the changes.

@phobson
Copy link
Member

phobson commented Mar 6, 2017

@vidursatija thanks for the changes and the PR in general. It's much appreciated. I'll try to find time to confirm that everything builds well tonight.

In the mean, perhaps it would make sense to embed the link to the requirements file. See this reference.

Something like:

The `requirements`_ are as follows:

## yada yada yada

.. _requirements:  https://github.com/matplotlib/matplotlib/blob/master/doc-requirements.txt

Copy link
Member

@NelleV NelleV left a comment

Choose a reason for hiding this comment

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

LGTM 👍
Thanks @vidursatija ! This is a great improvement.

@NelleV NelleV changed the title Document the documentation build requirements (closes #8174) [MRG+1] Document the documentation build requirements (closes #8174) Mar 6, 2017
@NelleV
Copy link
Member

NelleV commented Mar 19, 2017

@phobson can you re-review?
@vidursatija Do you mind rebasing? I can help you out if you don't how to do it?

@vidursatija
Copy link
Contributor Author

How can I rebase it?

@phobson
Copy link
Member

phobson commented Mar 20, 2017

@NelleV apporved!

@afvincent
Copy link
Contributor

@vidursatija Here is some doc on rebasing. I personally use the “interactive” fashion (git rebase -i), which (I find) gives you a bit more grip on what is done. I am not a heavy git user at all and it served me well up to now. If things go sour, you should find help on the Gitter channel.

@vidursatija
Copy link
Contributor Author

I think the problem occurred because I didn't change the branch while solving another PR. I'll still use rebase

@NelleV
Copy link
Member

NelleV commented Mar 23, 2017

@vidursatija sorry it took so long to get back to you.

Though it is better to work in a branch, this is unfortunately not the issue here. Basically, someone else has been editing the same file as you, which means you'll have to update your code base. There are two ways to do this: (1) merging; (2) rebasing. The latter is more complicated (with IMO little to 0 benefit…), but I can walk you through it.

The first step is going to be to update your remote branches. Assuming your github remote is called "origin" and the main matplotlib one is called "matplotlib", you can do this by git fetch matplotlib. This will update the code in the remote branch matplotlib/master.

The second step is the rebasing itself. Rebasing will update your master branch in such a way that your commits come after the ones that have been merged into matplotlib/master.
To do this step, do git rebase matplotlib/master. You'll probably have a conflict in which case you'll have to edit the file with the conflict to choose which lines to keep, and continue on with the rebase: first add the file(s) using git add filename to indicate that you've resolved the conflict, and then continue the rebase with git rebase --continue until the rebase is complete.

You can read more on rebase in our development guidelines: http://matplotlib.org/devel/gitwash/development_workflow.html#rebasing-a-pull-request-pr

@NelleV NelleV changed the title [MRG+1] Document the documentation build requirements (closes #8174) [MRG+2] Document the documentation build requirements (closes #8174) Mar 24, 2017
@vidursatija
Copy link
Contributor Author

I've resolved the conflicts by removing the conflicting lines.

@vidursatija
Copy link
Contributor Author

Due to some mistake I deleted the forked repository. I still have to add changes. How can I do it?

@@ -17,6 +18,7 @@ The requirements are as follows (https://github.com/matplotlib/matplotlib/blob/m
4. Mock
5. colorspacious
6. pillow
=======
Copy link
Member

Choose a reason for hiding this comment

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

i don't think this line of ==== belongs here

@NelleV
Copy link
Member

NelleV commented Mar 24, 2017

@vidursatija Do you still have the local changes on your computer?

@vidursatija
Copy link
Contributor Author

I have the file.

@NelleV
Copy link
Member

NelleV commented Mar 24, 2017

Unfortunately, that won't be enough to retrieve the changes you've lost. There is unfortunately no other option to start from scratch.

@vidursatija
Copy link
Contributor Author

Okay. I'll close this pull request and start a new one?

@NelleV
Copy link
Member

NelleV commented Mar 24, 2017

closed in favor of #8373

@NelleV NelleV closed this Mar 24, 2017
@QuLogic QuLogic changed the title [MRG+2] Document the documentation build requirements (closes #8174) Document the documentation build requirements (closes #8174) Mar 24, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants