Skip to content
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

Open
justinpenner opened this issue Mar 22, 2024 · 3 comments
Open

Missings docs (FloatingWindow, Window…) #207

justinpenner opened this issue Mar 22, 2024 · 3 comments

Comments

@justinpenner
Copy link

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?

image

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

@justvanrossum
Copy link
Collaborator

Would you be willing to contribute a PR?

@justinpenner
Copy link
Author

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).

@justinpenner
Copy link
Author

I suspect Window and FloatingWindow are being excluded due to their inheritance of NSObject. I noticed the Sphinx conf.py has a Mock class that seems to have a list of classes to be ignored. If that's where the problem lies, I'm not sure whether to remove NSObject from Mock.__all__, or if it would be enough to simply remove :inherited-members: from the autoclass declaration in Window.rst.

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.

typemytype added a commit that referenced this issue Apr 11, 2024
typemytype added a commit that referenced this issue May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants