Merge User Guide and API sections
Mr-Geekman opened this issue · comments
🚀 Feature Request
Currently in our prototype #1319 User Guide and API sections are very similar. We should rething them.
Proposal
- Extract guide "Installation guide for Apple M1 (ARM)" into Installation section
- Try to move info from user guide into API section
- Try to prune API section from classes that should be shown: private classes, mixins. This can be done for example by manually selection that should be shown like it is done in
numpy,pandasand many other libraries. Or we can point out what kind of objects should be ignored.
Test cases
No response
Additional context
No response
May be in the separate task we can create section about the base classes for developers
May be we can add separate section for native nets and nets from PTF
Why do we have section with the base classes for Transforms, but not for Models?
"Change-point transforms" and "Decomposition transforms:" are almost the same
Can we somehow improve sorting here?(in all the sections)I guess we should try to filter more such cases, this method is actually king of provate
Will we make "Basic usage" subsection for all the sections?
Also kind of private class
Why saving then?
Is everything ok with rendering?
Why aren't you commenting in PR?
Do we really need to display attributes like this?
Is everything ok with rendering?
I don't know, I didn't change it. It is how it looks in our current documentation. I think it depends on how the table is styled in each theme.
Do we really need to display attributes like this?
It is public, so why not? I just specified that we want to show public attributes and it rendered automatically to show these ones. If we don't what them to be shown we shouldn't have done them public. There are some options:
- Don't show attributes at all
- Don't show attributes in this particular case (we can do this by creating a separate page for this class).
Why saving then?
I don't understand what is the problem. Can you elaborate on this?
Can we somehow improve sorting here?(in all the sections)
Can you explain what is the problem with this order? It is ordered by the order in the Transforms document.
Closed by #1324.