Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
daizutabi committed Jun 16, 2020
1 parent b2773e2 commit 2a7891a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

## [Unreleased]

* BugFix: Include decorated functions if decorator uses `wraps()`.
* `all` filter for package or module to display all of the members and add links.

## Version 1.0.3 (2020-06-16)

* BugFix: Include functions decorated by Pytest ([#14](https://github.com/daizutabi/mkapi/issues/14)).
Expand Down
11 changes: 11 additions & 0 deletions docs/usage/module.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,14 @@ If you prefer upper case heading, use the `upper` filter.
~~~

### ![mkapi](google_style|upper)


## Display Members

`all` filter generates entire module documentation including class and function members. Note that Classes and Functions sections have links to the members

~~~
### ![mkapi](google_style|upper|all)
~~~

### ![mkapi](google_style|upper|all)

0 comments on commit 2a7891a

Please sign in to comment.