Skip to content

Commit 458598f

Browse files
committed
Fix docs due to doc(include) issues
See: rust-lang/rust#44732 rust-lang/rust#82539
1 parent a011d3b commit 458598f

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "ybc"
3-
version = "0.2.0"
3+
version = "0.2.1"
44
description = "A Yew component library based on the Bulma CSS framework."
55
authors = ["Anthony Dodd <dodd.anthonyjosiah@gmail.com>"]
66
edition = "2018"

src/lib.rs

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
1-
#![cfg_attr(feature = "docinclude", feature(external_doc))]
2-
#![cfg_attr(feature = "docinclude", doc(include = "../README.md"))]
1+
//! A [Yew](https://yew.rs) component library based on the [Bulma CSS](https://bulma.io) framework.
2+
//!
3+
//! YBC encapsulates all of the structure, style and functionality of the Bulma CSS framework as a
4+
//! set of Yew components. YBC also ships with support for the Yew Router, adding Bulma-styled
5+
//! components which wrap the Yew Router components for clean integration.
6+
//!
7+
//! As a guiding principal, YBC does not attempt to encapsulate every single Bulma style as a Rust
8+
//! type, let alone the many valid style combinations. That would be far too complex, and probably
9+
//! limiting to the user in many ways. Instead, YBC handles strucutre, required classes, functionality,
10+
//! sane defaults and every component can be customized with any additional classes for an exact look and feel.
11+
//!
12+
//! What does it look like to use YBC? The following is a snippet of a component's `view` method
13+
//! rendering a navbar, a fluid container, and some tiles.
14+
//!
15+
//! Please see [this project's README](https://github.com/thedodd/ybc) for the example. **Docs.rs is
16+
//! currently (2021.07.26) slightly broken and having trouble including external docs as it has historically.**
17+
// TODO: add this back in once it is no longer a land mine:
18+
// #![cfg_attr(feature = "docinclude", doc = include_str!("../README.md"))]
319
#![recursion_limit = "1024"]
420

521
mod columns;

0 commit comments

Comments
 (0)