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
Generate API references for plugin #10945
Comments
I second this. Honestly, sphinx-based automated documentation of the docstrings you guys already put in the code would make developing plugins much easier. Right now I read the code to find the docstrings. I'd rather search a website and click links since it's usually faster to navigate. |
Definitely agreed, and thanks for the feedback. I don't have much experience with Sphinx (and sorry for being lazy not searching myself) - do you know if it's possible to indicate which directories are valid to generate docs for? We want, for example, to generate |
Yes and if I remember correctly this generation is more opt-in than
opt-out, so it's pretty easy to tailor this.
I can perhaps help with this later this week or this weekend
…On Mon, Oct 19, 2020, 23:07 Eric Arellano ***@***.***> wrote:
Definitely agreed, and thanks for the feedback.
I don't have much experience with Sphinx (and sorry for being lazy not
searching myself) - do you know if it's possible to indicate which
directories are valid to generate docs for? We want, for example, to
generate engine/, but not engine/internals. And there may be certain
things in engine/ that we want to leave off too.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#10945 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAH5UHY5BINQAPHV5RRJN5LSLT5IJANCNFSM4SNIETMA>
.
|
I also expect that generating an explicit list of all |
Ideas from an internal Toolchain discussion that I had with @Eric-Arellano:
|
Second everything in this thread. Just completed my first semi-functional plugin and the biggest pain points are trying to navigate the rule chains. Being able to to navigate from a The only thing I might add is one of the hardest parts for me to grok was trying to understand how to go from a given input to a given output. As an example I ended up with a At the moment the only way to write plugins is to read a LOT of code and work your way backwards and hope you didn't miss an already written function/rule. |
When we do this, we should probably rewrite the docs. Right now, they have too much of a reference style, but with lots of prose. Instead, the reference should live in a dedicated reference section, so that the main docs can focus more on concepts + tutorials + how tos.
The text was updated successfully, but these errors were encountered: