Skip to content

Commit

Permalink
Show tables of methods for each set of endpoints in the API Resources (
Browse files Browse the repository at this point in the history
…#396)

* Show tables of methods for each set of endpoints in the API Resources pages. bump version for new release

* remove extraneous Methods rubric directive
  • Loading branch information
mheilman committed Jun 3, 2020
1 parent 44f7c24 commit 3fdceb9
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased

## 1.14.2 - 2020-06-03
### Added
- Added support for Python 3.8 (#391)

Expand All @@ -15,6 +17,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
- Added additional detail to `civis.io.dataframe_to_civis`, `civis.io.csv_to_civis`, and `civis.io.civis_file_to_table`'s docstrings on the primary key parameter. (#388)
- Made polling threads for Civis futures be daemon threads so that Python processes will shut down properly in Python 3.8 (#391)
- Removed deprecation warning on the `file_id` parameter of `civis.io.civis_file_to_table`. The parameter name will be kept in v2. (#360, #393)
- Show tables of methods for each set of endpoints in the API Resources pages. (#396)

## 1.14.1 - 2020-04-22
### Fixed
Expand Down
2 changes: 1 addition & 1 deletion civis/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "1.14.1"
__version__ = "1.14.2"
5 changes: 2 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -307,8 +307,8 @@
('py:class', 'concurrent.futures._base.Future'),
('py:class', 'civis.base.CivisAsyncResultBase')
]
numpydoc_show_class_members = False

# Show tables of functions for each Resource class.
numpydoc_show_class_members = True

# Preserve signatures of a few methods wrapped with lru_cache. Need to set
# this before we import civis. See https://stackoverflow.com/a/28371786.
Expand Down Expand Up @@ -344,7 +344,6 @@ def _attach_classes_to_module(module, class_data):
_autodoc_fmt = ('.. autoclass:: {}\n'
' :members:\n'
' :exclude-members: __init__\n\n'
' .. rubric:: Methods\n'
' .. generatedautosummary:: {}\n\n')


Expand Down

0 comments on commit 3fdceb9

Please sign in to comment.