Skip to content

fix rtd deps#316

Merged
MatthewSteen merged 4 commits intodevelopfrom
fix-rtd-deps
May 20, 2024
Merged

fix rtd deps#316
MatthewSteen merged 4 commits intodevelopfrom
fix-rtd-deps

Conversation

@MatthewSteen
Copy link
Member

Close #315.

@MatthewSteen MatthewSteen requested a review from gtfierro May 8, 2024 21:54
@gtfierro
Copy link
Collaborator

gtfierro commented May 9, 2024

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
Copy link
Member Author

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
Copy link
Collaborator

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!

Copy link
Collaborator

@gtfierro gtfierro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ran the builds and it worked great!

@MatthewSteen MatthewSteen merged commit a0811f5 into develop May 20, 2024
@MatthewSteen MatthewSteen deleted the fix-rtd-deps branch May 20, 2024 20:11
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

Successfully merging this pull request may close these issues.

fix ReadTheDocs dependencies

2 participants