search

ZcashFoundation / redjubjub

A minimal RedJubjub implementation for use in Zebra.
Other
28 stars 21 forks source link

Try to fix the docs build #123

Closed oxarbitrage closed 3 years ago

oxarbitrage commented 3 years ago

This PR at the moment is just to make some tests to see if we can fix the CI docs failure.

oxarbitrage commented 3 years ago

The last try seems to work, according to the previous error the removal of external_docs should be handled by the include_str! so the efefct should be the same:

12 | #![cfg_attr(feature = "nightly", feature(external_doc))]
   |                                          ^^^^^^^^^^^^ feature has been removed
   |
   = note: use #[doc = include_str!("filename")] instead, which handles macro invocations

However i don't have a way to confirming that the README is currently being included with this change.

dconnolly commented 3 years ago

I also vaguely tried to fix this rustdoc/compile error and never quite got the recommendations to work

dconnolly commented 3 years ago

I tested this by building the docs locally with nightly