Title: Add docs generation. by tychedelia · Pull Request #109 · processing/libprocessing · GitHub
Open Graph Title: Add docs generation. by tychedelia · Pull Request #109 · processing/libprocessing
X Title: Add docs generation. by tychedelia · Pull Request #109 · processing/libprocessing
Description: The docs are generated from the .pyi stubs that generate_stubs already produces. mkdocstrings reads them via griffe's static analysis to build the docs. Apparently this is best practice, there's no single rustdocs equivalent. A couple things worth noting: I had to set module.incomplete = false in generate_stubs because pyo3-introspection marks the module incomplete due to some python things I'm not sure about. allow_inspection: false tells giraffe to use the .pyi files. show_if_no_docstring: true is needed because the stubs don't have docstrings yet We should, in theory, be able to deploy this to github pages for now, which is what the CI sets up.
Open Graph Description: The docs are generated from the .pyi stubs that generate_stubs already produces. mkdocstrings reads them via griffe's static analysis to build the docs. Apparently this is best practice, there&...
X Description: The docs are generated from the .pyi stubs that generate_stubs already produces. mkdocstrings reads them via griffe's static analysis to build the docs. Apparently this is best practice, th...
Opengraph URL: https://github.com/processing/libprocessing/pull/109
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:ff337eec-e2ec-6efe-05c8-e1162531abf0 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | BC04:1381EF:554A6:79014:6A604A91 |
| html-safe-nonce | 9a96f76c5486f153c4c27a2382fec6308fd24fd26b9173faec9331a8cfffe88c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCQzA0OjEzODFFRjo1NTRBNjo3OTAxNDo2QTYwNEE5MSIsInZpc2l0b3JfaWQiOiI4MjQ0MzU4NDg0MzExNjg5ODczIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | d34696177d8f4efda9e2695cc2c7e4e22e68d114258b4bfdb03202e11c7e2db2 |
| hovercard-subject-tag | pull_request:3499981176 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/processing/libprocessing/pull/109/files |
| twitter:image | https://avatars.githubusercontent.com/u/10366310?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/10366310?s=400&v=4 |
| og:image:alt | The docs are generated from the .pyi stubs that generate_stubs already produces. mkdocstrings reads them via griffe's static analysis to build the docs. Apparently this is best practice, there&... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 60da8c2a42fa2bbf5f7567474990ec467836a84444262a58e200fa91b7f3d2d0 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/processing/libprocessing git https://github.com/processing/libprocessing.git |
| octolytics-dimension-user_id | 1617169 |
| octolytics-dimension-user_login | processing |
| octolytics-dimension-repository_id | 1101329545 |
| octolytics-dimension-repository_nwo | processing/libprocessing |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1101329545 |
| octolytics-dimension-repository_network_root_nwo | processing/libprocessing |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 9824515e740d83d5eb82168a089b806ab0fe04a1 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width