search

NREL / BuildingMOTIF

Building Metadata OnTology Interoperability Framework (BuildingMOTIF)
https://buildingmotif.readthedocs.io/
Other
42 stars 6 forks source link

fix rtd deps #316

Closed MatthewSteen closed 2 months ago

MatthewSteen commented 2 months ago

Close #315.

gtfierro commented 2 months ago

I think the BACnet issue you're hitting in the tests will be fixed by #310 . Is there a way to test that the new RTD configuration works? It looks good to me, but I'm not sure how to check that the build works

MatthewSteen commented 2 months ago

You can build locally with...

jupyter-book config sphinx docs/ ; sphinx-build docs/ docs/_build/html -b html

...which isn't exactly what RTD uses (below) but similar.

python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html`
Option Description
-T --show-traceback
-b --builder buildername (html, Build HTML pages. This is the default builder.)
-d --doctree-dir path
-D --define setting=value

We should try to have parity between the local and remote documentation for building the documentation, which I can add to the Developer Documentation section at some point in the future.

I ran the following command locally, which is closer to the RTD one and worked...

sphinx-build -T -b html -d _build/.doctrees -D language=en docs/  docs/_build/html
gtfierro commented 2 months ago

The second build command works fine for me! I think we need to merge #310 before this PR will pass though. Can you take a look at #310 and approve when you get a chance? Thanks!