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.

Sign up for GitHub

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

Jump to bottom

pyglui wiki #7

Open
4 tasks done
willpatera opened this issue Nov 4, 2014 · 2 comments
Open
4 tasks done

pyglui wiki #7

willpatera opened this issue Nov 4, 2014 · 2 comments
Labels
enhancement

Comments

@willpatera
Copy link
Member

Make a simple 1 page wiki for pyglui as documentation of code with diagrams and screenshots.

Initial todo items:

  • General explanation of code structure
  • UI - Diagram FitBox size and position rules (positive/negative vectors)
  • UI - Explain design org and design size vs. computed org and computed size
  • Layout - Diagram and explanation of hierarchy
@willpatera willpatera mentioned this issue Nov 4, 2014
Closed
@willpatera
Copy link
Member Author

Completed above tasks - page on the wiki is here: https://github.com/pupil-labs/pyglui/wiki/Structure

More explanation is required to explain ui_elements and the overall code structure of pyglui:

  • UI elements - explain the UI element class and one element like Slider as example to address Synced_Val
  • pyglui submodules
  • Menu types

@papr
Copy link
Contributor

papr commented Jun 9, 2017

An simple API reference is required. Starting point would be to generate docs from code and go from there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@papr @willpatera