Skip to content
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

Merged
merged 3 commits into from
Jan 17, 2023
Merged

Add make asm-docs #4590

merged 3 commits into from
Jan 17, 2023

Conversation

jeremy-rifkin
Copy link
Member

No description provided.

Makefile Outdated
$(MAKE) -C etc/scripts/docenizers

asm-docs-dependencies:
pip3 install beautifulsoup4 pdfminer.six
Copy link
Member Author

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?

Copy link
Member

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

Copy link
Member Author

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!

Copy link
Member Author

Choose a reason for hiding this comment

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

image
I decided to do the second option

@junlarsen
Copy link
Member

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?

@mattgodbolt
Copy link
Member

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.
Are they already in our "dev dependencies?"

@jeremy-rifkin
Copy link
Member Author

Looks like the dependency is cheerio which is in devDependencies

@jeremy-rifkin jeremy-rifkin merged commit 4a1b5a8 into main Jan 17, 2023
@jeremy-rifkin jeremy-rifkin deleted the jr/docenizer-makefile branch January 17, 2023 00:46
@mattgodbolt
Copy link
Member

Amazing stuff; thanks!

mattgodbolt pushed a commit that referenced this pull request Jan 24, 2023
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.

None yet

3 participants