NEW: Add type, format, transformer info to plugin pages #435
Conversation
|
Hey @Oddant1, have you chatted with @ChrisKeefe about reviewing this, first? If he has the availability to take a first pass before me, well, that would be great. Thanks! |
|
@thermokarst I will definitely do that. Also should add him as a co-author |
Oddant1
changed the title
Oddant1
changed the title
Co-Authored-By: ChrisKeefe <[email protected]>
|
Unfortunately GitHub doesn't seem to allow editing of commits to add co-authors from inside GitHub, but I think that last commit should add Chris |
|
Sigh nope, Hang on |
|
Just put the |
|
@thermokarst, sounds good, although it also looks like I have the wrong email for Chris? Because it added him and then the commit StackOverflow said I needed to make to not blow everything up took him off 😆, but when it added him it didn't create a link to his account |
Oddant1
changed the title
thermokarst
changed the title
…tps://github.com/Oddant1/docs into Add-type-format-transformer-info-to-plugin-pages
| @@ -49,12 +49,18 @@ def generate_rst(app): | |||
| transformers_list = [] | |||
|
|
|||
| for from_type, to_type in plugin.transformers: | |||
| from_type = repr(from_type).split('.')[-1].replace("'>", '') | |||
| to_type = repr(to_type).split('.')[-1].replace("'>", '') | |||
| from_type = repr(from_type) \ | |||
There was a problem hiding this comment.
DBC:
Please see this PEP for a simpler way to do this: https://www.python.org/dev/peps/pep-3155/
An example in QIIME 2 can be found here: https://github.com/qiime2/qiime2/blob/46541f547c92714079dbd0342e10a85b74522305/qiime2/core/util.py#L28
There was a problem hiding this comment.
On second thought, you might just want to look at using get_view_name, outright.
There was a problem hiding this comment.
If you use get_view_name outright, we will probably need to open a tiny PR on the framework to expose that util through sdk (right now it is only in core).
|
@7d0436e Moves the types, formats, and transformers to their own pages, these pages are not finished at this time. Additionally, the docs do not build without warnings right now, it warns that some of the |
|
I've noticed some oddities in the formats sets we've created, only two items in the Exportable Formats set actually say they're formats. One of them appears to be a pipeline which doesn't seem like it should be there (see the last entry in the list).
All these entries in the set came from the dictionary of transformers that already existed on the
I'm not sure if this is actually a problem, but it doesn't seem right to me. |
|
Yikes! Not sure how those all sent as individual messages, meant to submit as a comment-review. Sorry! |
|
b9a5f90 Still gives warnings on the templates not being included in any toctree |
|
This is a nice idea, I wonder if we can include something like this after the November release when we re-vamp the dev docs. @ebolyen any thoughts? |
|
Closing in favor of #543 |
Adds dummy lists of types, formats, and transformers to plugin pages. These list entries currently have no link associated with them. This code is also currently producing this on the "Available plugins" page for plugins with types, formats, or transformers:
There are no list entries there because the pages the entries would be linking to do not yet exist.