DOC: Move content in doc/README.rst to doc/source/contributing.rst #23840
Conversation
doc/README.rst
Outdated
| Where to start? | ||
| --------------- | ||
|
|
||
| Please follow the documentation in ``doc/source/contributing.rst`` for a | ||
| detailed guide on how to contribute to documentation |
There was a problem hiding this comment.
Could use a period at the end of this statement
Codecov Report
@@ Coverage Diff @@
## master #23840 +/- ##
==========================================
+ Coverage 92.29% 92.29% +<.01%
==========================================
Files 161 161
Lines 51490 51501 +11
==========================================
+ Hits 47521 47534 +13
+ Misses 3969 3967 -2
Continue to review full report at Codecov.
|
doc/source/contributing.rst
Outdated
| Starting with 0.13.1 you can tell ``make.py`` to compile only a single section | ||
| of the docs, greatly reducing the turn-around time for checking your changes. | ||
| You will be prompted to delete `.rst` files that aren't required, since the | ||
| last committed version can always be restored from git. |
There was a problem hiding this comment.
You can delete those two last lines, that's not true anymore. Also the Starting with 0.13.1, that version is from 2015, I think we can assume nobody is using it anymore.
doc/source/contributing.rst
Outdated
|
|
||
| .. warning:: | ||
|
|
||
| Sphinx version >= 1.2.2 or the older 1.1.3 is required. |
There was a problem hiding this comment.
You can remove the warning, I don't think that's true anymore, and in any cases, those versions are old enough to assume everybody uses something more modern.
doc/source/contributing.rst
Outdated
| the notebooks included in the documentation. | ||
|
|
||
| Furthermore, it is recommended to have all `optional dependencies | ||
| <http://pandas.pydata.org/pandas-docs/dev/install.html#optional-dependencies>`_ |
There was a problem hiding this comment.
You can remove this paragraph, the optional dependencies file doesn't exist anymore, there is just a dependencies file now.
doc/README.rst
Outdated
| Where to start? | ||
| --------------- | ||
|
|
||
| Please follow the documentation in ``doc/source/contributing.rst`` for a |
There was a problem hiding this comment.
I'd remove the titles, and paragraphs and leave something as simple as:
See `doc/source/contributing.rst` in this repo, or the generated html version https://pandas.pydata.org/pandas-docs/stable/contributing.html
Not a big difference, but leaving the titles and some info gives the wrong impression that this is a page (that could be extended) instead of a "redirect".
doc/README.rst
Outdated
| @@ -1,24 +1,3 @@ | |||
| .. _contributing.docs: | |||
There was a problem hiding this comment.
Do you mind also removing this? I don't think we want to link to this README (and probably we can't as this is not in the sphinx sources dir). And it's confusing to have it here.
doc/source/contributing.rst
Outdated
| @@ -394,6 +399,31 @@ Requirements | |||
| First, you need to have a development environment to be able to build pandas | |||
| (see the docs on :ref:`creating a development environment above <contributing.dev_env>`). | |||
|
|
|||
| To build the pandas docs there are some extra requirements: you will need to | |||
There was a problem hiding this comment.
this is very duplicative, Creating a Python Environment.
|
Totally fine with doing that, simple change |
yes |
doc/README.rst
Outdated
| Feel free to ask questions on `mailing list | ||
| <https://groups.google.com/forum/?fromgroups#!forum/pydata>`_ or submit an | ||
| issue on Github. | ||
| See `doc/source/contributing.rst` in this repo, or the generated html version https://pandas.pydata.org/pandas-docs/stable/contributing.html |
There was a problem hiding this comment.
can you make the contributing link a markdown link. I think you can also path directly to the .rst with this link: https://github.com/pandas-dev/pandas/blob/master/doc/source/contributing.rst
|
I wasn't sure if this is what you meant by markdown link, is my new commit correct? |
Co-Authored-By: KimiJL <[email protected]>
|
thanks @KimiJL |
git diff upstream/master -u -- "*.py" | flake8 --diff