-
Notifications
You must be signed in to change notification settings - Fork 28
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
Missings docs (FloatingWindow, Window…) #207
Comments
Would you be willing to contribute a PR? |
I'll take a closer look. I've never used Sphinx before, but I think I understand the gist of how it works (class/method defs and docstrings w/ markup are parsed into .rst format, then Sphinx generates .html doc pages). |
I suspect Window and FloatingWindow are being excluded due to their inheritance of NSObject. I noticed the Sphinx conf.py has a If anyone more knowledgeable of Sphinx can finish solving this, please do. Otherwise I'll come back to this later when I have time to clone the repo and figure out how to run Sphinx. |
https://vanilla.robotools.dev/en/latest/objects/Window.html
https://vanilla.robotools.dev/en/latest/objects/FloatingWindow.html
Most doc pages begin with the class constructor and some examples and descriptions, like the image below. This is missing from the Window and FloatingWindow doc pages linked above. It seems like these two classes are documented properly in the source code, so maybe there is a small syntax error preventing them from being pulled into the docs?
Additionally, I noticed two doc pages are completely empty:
https://vanilla.robotools.dev/en/latest/objects/Sheet.html
https://vanilla.robotools.dev/en/latest/objects/List.html
The text was updated successfully, but these errors were encountered: