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

Fix documentation #239

Merged
merged 1 commit into from
Jan 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ panic = 'unwind'

[workspace]
members = [
"core/cli",
"core/ethash",
"core/cli",
"core/ethash",
# "core/merkle-mountain-range",
# "core/fly-client",
"core/sr-eth-primitives",
"core/merkle-patricia-trie",

"node/cli",
"node/cli",
"node/executor",
"node/primitives",
"node/rpc",
Expand Down
13 changes: 8 additions & 5 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -316,18 +316,21 @@ curl -H 'Content-Type: application/json' --data '{ "jsonrpc":"2.0", "method":"au
You can generate documentation for a Darwinia Rust package and have it automatically open in your web browser using https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html#using-rustdoc-with-cargo[rustdoc with Cargo],
(of the The Rustdoc Book), by running the following command:

```
cargo doc --open
```

If you just want to generate document from specific package, you may use following command:

```
cargo doc --package <spec> --open
```

Replacing `<spec>` with one of the following (i.e. `cargo doc --package darwinia --open`):
Replacing `<spec>` with one of the following (i.e. `cargo doc --package darwinia-cli --open`):

* All Darwinia Packages
[source, shell]
darwinia
* Darwinia Core
[source, shell]
darwinia, darwinia-cli, ethash, fly-client,
darwinia-cli, ethash, fly-client,
merkle-mountain-range, merkle-patricia-trie, sr-eth-primitives
* Darwinia Runtime Module Library
[source, shell]
Expand Down
2 changes: 1 addition & 1 deletion node/cli/bin/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
// You should have received a copy of the GNU General Public License
// along with Substrate. If not, see <http://www.gnu.org/licenses/>.

//! Substrate Node CLI
//! Darwinia

#![warn(missing_docs)]

Expand Down
2 changes: 1 addition & 1 deletion node/cli/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
// You should have received a copy of the GNU General Public License
// along with Substrate. If not, see <http://www.gnu.org/licenses/>.

//! Substrate CLI library.
//! Darwinia CLI library.

#![warn(missing_docs)]
#![warn(unused_extern_crates)]
Expand Down