Skip to content

Commit

Permalink
docs: Specify html_root_url for all crates
Browse files Browse the repository at this point in the history
This should let docs.rs link to sub-crates properly https://github.com/onur/docs.rs/issues/128
  • Loading branch information
Marwes committed May 23, 2017
1 parent e306d2a commit 83a21c3
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 0 deletions.
1 change: 1 addition & 0 deletions base/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
//! The base crate contains pervasive types used in the compiler such as type representations, the
//! AST and some basic containers.
#![doc(html_root_url="https://docs.rs/gluon_base/0.4.0/gluon_base")] // # GLUON

extern crate log;
#[macro_use]
Expand Down
1 change: 1 addition & 0 deletions c-api/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
//! A (WIP) C API allowing use of gluon in other langauges than Rust.
#![doc(html_root_url="https://docs.rs/gluon_c-api/0.4.0/gluon_c-api")] // # GLUON

extern crate libc;
extern crate gluon;
Expand Down
1 change: 1 addition & 0 deletions check/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
//! If an AST passes the checks in `Typecheck::typecheck_expr` (which runs all of theses checks
//! the expression is expected to compile succesfully (if it does not it should be considered an
//! internal compiler error.
#![doc(html_root_url="https://docs.rs/gluon_check/0.4.0/gluon_check")] // # GLUON

#[macro_use]
extern crate log;
Expand Down
1 change: 1 addition & 0 deletions parser/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
//! The parser is a bit more complex than it needs to be as it needs to be fully specialized to
//! avoid a recompilation every time a later part of the compiler is changed. Due to this the
//! string interner and therefore also garbage collector needs to compiled before the parser.
#![doc(html_root_url="https://docs.rs/gluon_parser/0.4.0/gluon_parser")] // # GLUON

#[macro_use]
extern crate log;
Expand Down
3 changes: 3 additions & 0 deletions repl/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
//! REPL for the gluon programming language
#![doc(html_root_url="https://docs.rs/gluon_repl/0.4.1/gluon_repl")] // # GLUON

#[macro_use]
extern crate log;
#[cfg(feature = "env_logger")]
Expand Down
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
//! behaviour. For information about how to use this library the best resource currently is the
//! [tutorial](https://github.com/gluon-lang/gluon/blob/master/TUTORIAL.md) which contains examples on
//! how to write gluon programs as well as how to run them using this library.
#![doc(html_root_url="https://docs.rs/gluon/0.4.0/gluon")] // # GLUON
#[macro_use]
extern crate log;
#[macro_use]
Expand Down
3 changes: 3 additions & 0 deletions version.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,6 @@ perl -p -i -e 's/version *= *"[0-9.]+"([^#]+)# GLUON/version = "'$1'"$1# GLUON/'

perl -p -i -e 's/^gluon *= *"[0-9.]+"/gluon = "'$1'"/' \
README.md

perl -p -i -e 's/[0-9][0-9.]+([^#]+)# GLUON/'$1'$1# GLUON/' \
$(ls **/src/lib.rs src/lib.rs)
1 change: 1 addition & 0 deletions vm/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
//! Crate which contain the virtual machine which executes gluon programs
#![doc(html_root_url="https://docs.rs/gluon_vm/0.4.0/gluon_vm")] // # GLUON

#[macro_use]
extern crate log;
Expand Down

0 comments on commit 83a21c3

Please sign in to comment.