-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
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
Conversation
Only the file is edited and not build using Sphinx
doc/devel/documenting_mpl.rst
Outdated
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) |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
Please pull the changes. |
@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:
|
There was a problem hiding this 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.
@phobson can you re-review? |
How can I rebase it? |
@NelleV apporved! |
@vidursatija Here is some doc on rebasing. I personally use the “interactive” fashion ( |
I think the problem occurred because I didn't change the branch while solving another PR. I'll still use rebase |
@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 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. You can read more on rebase in our development guidelines: http://matplotlib.org/devel/gitwash/development_workflow.html#rebasing-a-pull-request-pr |
I've resolved the conflicts by removing the conflicting lines. |
Due to some mistake I deleted the forked repository. I still have to add changes. How can I do it? |
doc/devel/documenting_mpl.rst
Outdated
@@ -17,6 +18,7 @@ The requirements are as follows (https://github.com/matplotlib/matplotlib/blob/m | |||
4. Mock | |||
5. colorspacious | |||
6. pillow | |||
======= |
There was a problem hiding this comment.
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
@vidursatija Do you still have the local changes on your computer? |
I have the file. |
Unfortunately, that won't be enough to retrieve the changes you've lost. There is unfortunately no other option to start from scratch. |
Okay. I'll close this pull request and start a new one? |
closed in favor of #8373 |
Only the file is edited and not build using Sphinx