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.

Sign up for GitHub

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

Jump to bottom

docs.rs can't build documentation for 0.4 #587

Closed
Pratyush opened this issue Jan 21, 2023 · 2 comments · Fixed by #590
Closed

docs.rs can't build documentation for 0.4 #587

Pratyush opened this issue Jan 21, 2023 · 2 comments · Fixed by #590
Assignees
@mmaker @Pratyush
Labels
T-documentation Type: doc improvements

Comments

@Pratyush
Copy link
Member

See the error log here: https://docs.rs/crate/ark-ff/0.4.0/builds/723044
@Pratyush Pratyush added the T-documentation Type: doc improvements label Jan 21, 2023
@Pratyush Pratyush mentioned this issue Jan 21, 2023
Open
@mmaker
Copy link
Member

mmaker commented Jan 21, 2023

ouch -- you think this thing is downloading ark-ff without the rest of the workspace?

@Pratyush
Copy link
Member Author

Yeah, I think it's because the include in Cargo.toml only includes certain files: https://github.com/arkworks-rs/algebra/blob/master/ff/Cargo.toml#L11

vmx added a commit to vmx/algebra that referenced this issue Jan 25, 2023
@vmx
Build docs correctly on docs.rs
bcbc702 
The `ark-ff` docs currently cannot be built on docs.rs. The problem is
that it refers to a file that is outside the crate. This commit fixes
the problem.

`ark-ec` is also using LaTeX in its documentation, hence include the
KaTeX header there as well.

Fixes arkworks-rs#587.
@vmx vmx mentioned this issue Jan 25, 2023
Merged
6 tasks
Pratyush pushed a commit that referenced this issue Feb 3, 2023
@vmx
Build docs correctly on docs.rs (#590)
4e4fc17 
Co-authored-by: Pratyush Mishra <pratyushmishra@berkeley.edu>
closes #587
paberr pushed a commit to paberr/algebra that referenced this issue Feb 22, 2023
@vmx @paberr
Build docs correctly on docs.rs (arkworks-rs#590)
f7c0080 
Co-authored-by: Pratyush Mishra <pratyushmishra@berkeley.edu>
closes arkworks-rs#587
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mmaker mmaker

@Pratyush Pratyush

Labels
T-documentation Type: doc improvements
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Build docs correctly on docs.rs vmx/algebra
2 participants
@mmaker @Pratyush