Skip to content

Commit

Permalink
README and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vreuter committed Apr 11, 2019
1 parent 301f2d1 commit d018fb6
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# lucidoc

[![Build Status](https://travis-ci.org/vreuter/lucidoc.svg?branch=dev)](https://travis-ci.org/vreuter/lucidoc)
[![Build Status](https://travis-ci.org/vreuter/lucidoc.svg?branch=master)](https://travis-ci.org/vreuter/lucidoc)
[![Coverage Status](https://coveralls.io/repos/github/vreuter/lucidoc/badge.svg?branch=master)](https://coveralls.io/github/vreuter/lucidoc?branch=master)

From docstrings generate package API documentation in Markdown
Expand Down
5 changes: 3 additions & 2 deletions docs/autodoc_build/lucidoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ def doc_callable(f, docstr_parser, render_tag, name=None)
### doc\_class
For single class definition, get text components for Markdown documentation.
```python
def doc_class(cls, docstr_parser, render_tag, include_inherited)
def doc_class(cls, docstr_parser, render_tag, include_inherited, nested=False)
```

**Parameters:**
Expand All @@ -414,6 +414,7 @@ def doc_class(cls, docstr_parser, render_tag, include_inherited)
- `docstr_parser` -- `lucidoc.DocstringParser`: How to parse a docstring.
- `render_tag` -- `callable(lucidoc.DocTag) -> str`: how to render anindividual tag from a docstring. The implementation in the object passed as an argument should handle each type of DocTag that may be passed as an argument when this object is called.
- `include_inherited` -- `bool`: include inherited members
- `nested` -- `bool`: whether the given target is nested within another class


**Returns:**
Expand Down Expand Up @@ -529,4 +530,4 @@ def run_lucidoc(pkg, parse_style, outfile=None, outfolder=None, no_mod_docstr=Fa



**Version Information**: `lucidoc` v0.3dev, generated by `lucidoc` v0.3dev
**Version Information**: `lucidoc` v0.3, generated by `lucidoc` v0.3

0 comments on commit d018fb6

Please sign in to comment.