Skip to content

DOC: Move content in doc/README.rst to doc/source/contributing.rst #23840

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Nov 27, 2018
Merged

DOC: Move content in doc/README.rst to doc/source/contributing.rst #23840

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c98e523
23828 moved content to contributing, and updated rebase command to merge
KimiJL Nov 21, 2018
211c96f
23828 added a missing period
KimiJL Nov 21, 2018
4b8e2e1
23828 cleaned up outdated documentation and README
KimiJL Nov 21, 2018
a2fbaa3
23828 removed a link in README
KimiJL Nov 21, 2018
fcd7e6c
reset contributing.rst
KimiJL Nov 21, 2018
a8966b8
23828 change README to link
KimiJL Nov 26, 2018
4872a62
Update doc/README.rst
datapythonista Nov 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 1 addition & 22 deletions doc/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,3 @@
.. _contributing.docs:
Copy link
Member

Choose a reason for hiding this comment

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

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.


Contributing to the documentation
=================================

Where to start?
---------------

Please follow the documentation in ``doc/source/contributing.rst`` for a
detailed guide on how to contribute to documentation.

There are a number of issues listed under `Docs
<https://github.com/pandas-dev/pandas/issues?labels=Docs&sort=updated&state=open>`_
and `good first issue
<https://github.com/pandas-dev/pandas/issues?labels=good+first+issue&sort=updated&state=open>`_
where you could start out.

Or maybe you have an idea of your own, by using pandas, looking for something
in the documentation and thinking 'this can be improved', let's do something
about that!

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
Copy link
Contributor

Choose a reason for hiding this comment

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

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

19 changes: 2 additions & 17 deletions doc/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,18 +408,6 @@ code. `nbsphinx <https://nbsphinx.readthedocs.io/>`_ is used to convert
Jupyter notebooks. You will need to install it if you intend to modify any of
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>`_
installed. This is not needed, but be aware that you will see some error
messages. Because all the code in the documentation is executed during the doc
build, the examples using this optional dependencies will generate errors.
Run ``pd.show_versions()`` to get an overview of the installed version of all
dependencies.

.. warning::

Sphinx version >= 1.2.2 or the older 1.1.3 is required.

Building pandas
^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -455,11 +443,8 @@ If you want to do a full clean build, do::
python make.py clean
python make.py html


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.
You can tell ``make.py`` to compile only a single section of the docs, greatly
reducing the turn-around time for checking your changes.

::

Expand Down