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

... online OpenStudio SDK documentation for "functions"? #5352

Open
brgix opened this issue Feb 6, 2025 · 3 comments
Open

... online OpenStudio SDK documentation for "functions"? #5352

brgix opened this issue Feb 6, 2025 · 3 comments

Comments

@brgix
Copy link

brgix commented Feb 6, 2025

Pretty much a word-for-word re-transcription of a recent UMH post:


Up until v3.6.1, one could consult OpenStudio SDK online documentation on functions (e.g. joinAll, polygonInPolygon) under the OpenStudio:Utilities Namespace Reference document:

Image

These (very useful) functions are still available (and working) with OpenStudio version 3.7.0 and up. Yet I'm now hitting a dead end for v3.7.0+ online SDK documentation:

Image

I may be missing something really obvious. Any hints where similar content (possibly updated) may be found for versions 3.7.0+? Thanks in advance.

@wenyikuang
Copy link
Collaborator

Thanks for bring it up, probably due to some misconfig in the documentations generated, let me try to genreated it again and see.

@jmarrec
Copy link
Collaborator

jmarrec commented Feb 7, 2025

FWIW, I just built the documentation locally on my mac with doxygen --version 1.13.2, and I do have the missing page.

Except it seems like it incldues the model/ namespace into it (I'm looking at file:///path/to/OS-build-dir/doc/utilities/html/namespaceopenstudio.html

@wenyikuang
Copy link
Collaborator

wenyikuang commented Mar 5, 2025

If I generated the doc with 1.9.* and 1.10.* the namespace cannot rendered correctly (empty html) and the indexSectionLabels cannot be generated correctly.

If I generate the doc with 1.13.2 the namespaceopenstudio.html will generated correctly and indexSectionLabels in searchdata.js will be genereted correctly but the search filter cannot be rendered correctly. Very strange.

I think at least we could bump the jquery and the Mathjax. it's from 2014...

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

3 participants