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

docs: Expand Configuration>Reporters section. #741

Merged
merged 1 commit into from
Dec 20, 2022

Conversation

ryneeverett
Copy link
Contributor

  • Diagram reporter hierarchy. This also serves to list the available reporters.
  • More explicitly distinguish between common options and reporter-specific options.

I would note that I initially tried the sphinx.ext.inheritance_diagram directive but I found the resulting graphviz image buggy, hard to read, and also useless for the man page. So I implemented an extension myself and tried to mimick the unix tree command format, mostly due to lack of creativity.

   html
   text
   ├───stdout
   ├───email
   ├───ifttt
   ├───text
   │   ├───pushover
   │   └───pushbullet
   ├───mailgun
   ├───telegram
   ├───slack
   │   └───mattermost
   ├───discord
   ├───xmpp
   ├───prowl
   └───shell
   markdown
   └───matrix

- Diagram reporter hierarchy. This also serves to list the available
  reporters.
- More explicitly distinguish between common options and
  reporter-specific options.
Copy link
Owner

@thp thp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haha neat! I like it.

@thp thp merged commit 25269fb into thp:master Dec 20, 2022
@ryneeverett
Copy link
Contributor Author

Looking back at this, I just noticed that WebServiceReporter doesn't have a __kind__ attribute.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants