Skip to content

Commit

Permalink
Add render documentation section; update README
Browse files Browse the repository at this point in the history
  • Loading branch information
burnash committed Apr 17, 2020
1 parent 5c240ba commit 23d63e7
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
19 changes: 18 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ GS_CREDS_FILENAME=<YOUR_CREDS.json> nosetests -vv tests/test.py

where `YOUR_CREDS.json` is a path to the file you downloaded in step 1.

**Tip:** To run a specific test method append its name in the form of `:TestClassName.test_method_name` to `tests/test.py`.
**Tip:** To run a specific test method append its name in the form of `:TestClassName.test_method_name` to `tests/test.py`.

Example:

Expand All @@ -49,3 +49,20 @@ You can control Betamax's [Record Mode](https://betamax.readthedocs.io/en/latest
GS_RECORD_MODE=all GS_CREDS_FILENAME=<YOUR_CREDS.json> nosetests -vv tests/test.py
```

## Render Documentation

The documentation uses [reStructuredText](http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html#rst-index) markup and is rendered by [Sphinx](http://www.sphinx-doc.org/).

To build the documentation locally, install Sphinx:

```
pip install Sphinx
```

Then from the project directory, run:

```
sphinx-build -b html docs html
```

Once finished, the rendered documentation will be in `html` folder. `index.html` is an entry point.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Before opening an issue, search the tracker for possible duplicates. If you find

### Improve Documentation

If you spot areas in [documentation](https://gspread.readthedocs.io/) that you think could be better, please submit a pull request. Docs are located in [`docs`](https://github.com/burnash/gspread/tree/master/docs) folder, use [reStructuredText](http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html#rst-index) markup and rendered by [Sphinx](http://www.sphinx-doc.org/).
[Documentation](https://gspread.readthedocs.io/) is as important as code. If you know how to make it more consistent, readable and clear, please submit a pull request. The documentation files are in [`docs`](https://github.com/burnash/gspread/tree/master/docs) folder, use [reStructuredText](http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html#rst-index) markup and rendered by [Sphinx](http://www.sphinx-doc.org/).

### Contribute code

Expand Down

0 comments on commit 23d63e7

Please sign in to comment.