-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Add make asm-docs
#4590
Add make asm-docs
#4590
Conversation
Makefile
Outdated
$(MAKE) -C etc/scripts/docenizers | ||
|
||
asm-docs-dependencies: | ||
pip3 install beautifulsoup4 pdfminer.six |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this taboo to do in a makefile?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To me: yes - sorry! I think we probably should (but maybe not in this PR) make a virtual environment etc like we do in infra
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Would it be better to add some docs somewhere saying "To re-generate the asm docs run pip3 install beautifulsoup4 pdfminer.six && npm i && make asm-docs
" or to just add a message to the rule saying "If this errors, install xyz"?
Side note I'm realizing I need to fix some rules here, will do this evening!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure doing this is as straight-forward as this, as both Java and LLVM docenizers are JavaScript code that depends on some installed node modules. What do you think? |
|
Looks like the dependency is |
Amazing stuff; thanks! |
No description provided.