DidierRLopes
commented
3 years ago I think this is exactly what we need. If I could see the perfection implementation it would have to meet the following requirements: High level:
- Be able to search to a feature based on the name of command or it's description
- Be able to see what features a particular menu has
Low level
- See a clear description of the feature
- See some additional resources to look more into feature
- Know what data source is used for this feature
- Know what's the name of the key used for this feature
- Know what parameters can be used with the feature
- See a screenshot of what to expect from this feature
- Have a button that could pop the code of the _view of this feature. This is useful for users that want to build their own notebook reports to dig into what features they want and how to call them.
@jmaslek thoughts?
piiq
There is an older an older implementation of the autogenerated class library with Shinx+readthedocs at https://gamestonk-terminal.readthedocs.io/
It's time this documentation generating pipeline is revisited and upgraded to:
There is nice up-to-date user documentation at https://gamestonkterminal.github.io/GamestonkTerminal/. Merging developer and user documentation can also be considered, especially if there are tools to automate doc generation for Hugo.
Notes:
docs/, the user docs that are built with hugo reside inwebsite/sphinx-apidocapp that comes with sphinx can parse all modules and autogenerate the class library in .rst format. That class library will contains all the functions. Browsing it is not pleasant, but the search works so technically it's usable. Example command would bemyst-parser="^0.15.2"is required