Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs v0.6.0 #689

Merged
merged 18 commits into from
Dec 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ pydoc-markdown pydoc-markdown-preprocessor.yml
pydoc-markdown pydoc-markdown-reader.yml
pydoc-markdown pydoc-markdown-generator.yml
pydoc-markdown pydoc-markdown-retriever.yml
pydoc-markdown pydoc-markdown-pipelines.yml
```

(Or run one of the commands above to update the docstrings only for a single module)
Expand All @@ -43,4 +44,4 @@ Pydoc will read the configuration from a `.yml` file which is located in the cur
- **renderer**: A plugin that produces the output files.
- **type**: Define the renderer which you want to use. We are using the Markdown renderer as it can be configured in very detail.
- **descriptive_class_title**: Remove the word "Object" from class titles.
- **filename**: file name of the generated file
- **filename**: file name of the generated file
Loading