search

NREL / BuildingMOTIF

Building Metadata OnTology Interoperability Framework (BuildingMOTIF). For models, see https://models.open223.info/
https://buildingmotif.readthedocs.io/
Other
49 stars 7 forks source link

Fix tutorials #310

Closed gtfierro closed 4 months ago

gtfierro commented 6 months ago

Cleaning up the language and fixing runtime exceptions

MatthewSteen commented 6 months ago

Which docs are you trying to fix, GitHub Pages or ReadTheDocs? Looks like each one has different errors. We should try to get RTD fixed and remove GitHub Pages, which I can do in a separate PR if you'd like.

gtfierro commented 6 months ago

docs gets deployed to Github pages, right? I like the JupyterBook interface we have. That's the one I am trying to fix

MatthewSteen commented 6 months ago

Yes...and RTD, which is confusing for all and my fault because I haven't completely finished the docs deployment.

JB uses RTD for their docs, so I think we can just follow what they do, which is what we want, i.e. RTD for versioned docs (latest and main/stable).

For RTD, I think the first step is to add the python section from https://github.com/executablebooks/jupyter-book/blob/aee488a3c071e2ae8167cc8a184aed245df205be/.readthedocs.yml#L12-L15 to our .readthedocs.yaml so that it imports BM.

image