fix: only write masm documentation when it's not docs.rs building the…

mFragaBA commented 1 month ago

closes #1208

Describe your changes

Omits the MASM documentation generation if DOCS_RS env var is on. Currently, doc build for stdlib fails because most directories in the docs.rs container are read only. To fix this, since built MASM documentation shouldn't be needed in order to build the rust documentation we check the DOCS_RS env var to see if we do it or not.

Checklist before requesting a review

Repo forked and branch created from next according to naming convention.
Commit messages and codestyle follow conventions.
Relevant issues are linked in the PR description.
Tests added for new functionality.
Documentation/comments updated according to changes.

mFragaBA commented 1 month ago

Looks good! Thank you!

One thing: could you rebase it on the main branch? This way, I can make a patch release of the crate to verify that all is working.

should be changed now. I wanted to use the docs.rs image locally to test it but it's taking waaaaay too long so it'll probably be faster if you do the test deploy

bobbinth commented 1 month ago

Published to crates.io and seems like the docs are now working. Thank you again for fixing this!

mFragaBA commented 1 month ago

Published to crates.io and seems like the docs are now working. Thank you again for fixing this!

Thank you for the reviews! Should we also try releasing the doc for miden-client? I think it wasn't building because of the error on stdlib

bobbinth commented 1 month ago

Done! Everything seems to work as expected.

0xPolygonMiden / miden-vm

fix: only write masm documentation when it's not docs.rs building the… #1341

Describe your changes

Checklist before requesting a review