From e16cff476614fe291796504e33dc427bb1e8315f Mon Sep 17 00:00:00 2001 From: Jeff Reback Date: Tue, 7 Mar 2017 09:45:09 -0500 Subject: [PATCH] add contributing.rst to index.rst --- docs/source/contributing.rst | 16 ++++++++-------- docs/source/index.rst | 1 + docs/source/reading.rst | 4 ++-- docs/source/tables.rst | 4 ++-- 4 files changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index c9de36e2..f0cb5bdb 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -37,21 +37,21 @@ Bug reports must: #. Include a short, self-contained Python snippet reproducing the problem. You can format the code nicely by using `GitHub Flavored Markdown - `_:: + `__ + + .. code-block:: python - ```python >>> from pandas_gbq import gbq >>> df = gbq.read_gbq(...) ... - ``` -#. Include the full version string of *pandas-gbq*. :: +#. Include the full version string of *pandas-gbq*. + + .. code-block:: python - ```python >>> import pandas_gbq >>> pandas_gbq.__version__ ... - ``` #. Explain why the current behavior is wrong/not desired and what you expect instead. @@ -282,7 +282,7 @@ directive. This should also be put in the docstring when adding a new function or method. Contributing your changes to *pandas-gbq* -===================================== +========================================= Committing your code -------------------- @@ -438,4 +438,4 @@ branch has not actually been merged. The branch will still exist on GitHub, so to delete it there do:: - git push origin --delete shiny-new-feature \ No newline at end of file + git push origin --delete shiny-new-feature diff --git a/docs/source/index.rst b/docs/source/index.rst index 3e22b972..44a61843 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -30,6 +30,7 @@ Contents: writing.rst tables.rst api.rst + contributing.rst changelog.rst diff --git a/docs/source/reading.rst b/docs/source/reading.rst index 6b39cbd0..ebfcfa9b 100644 --- a/docs/source/reading.rst +++ b/docs/source/reading.rst @@ -1,7 +1,7 @@ .. _reader: -Reading -======= +Reading Tables +============== Suppose you want to load all data from an existing BigQuery table : `test_dataset.test_table` into a DataFrame using the :func:`~read_gbq` function. diff --git a/docs/source/tables.rst b/docs/source/tables.rst index 936ccb4e..ba07125d 100644 --- a/docs/source/tables.rst +++ b/docs/source/tables.rst @@ -1,7 +1,7 @@ .. _create_tables: -Creating BigQuery Tables -======================== +Creating Tables +=============== .. code-block:: ipython