What's the best documentation solution other than docs.rs?

help
3

where GitHub Pages + travis will work i find gitlab pages way more easy to setup.
All you need is a '.gitlab-ci.yml' with following content

image: "scorpil/rust:stable"

stages:
  - test
  - doc
  - deploy

# Use cargo to test the project
test:stable:
  stage: test
  script:
    - rustc --version && cargo --version # Print version info for debugging
    - cargo test --verbose
    - cargo build --features=cli

test:beta:
  image: "scorpil/rust:beta"
  stage: test
  script:
    - rustc --version && cargo --version # Print version info for debugging
    - cargo test --verbose
    - cargo build --features=cli

test:nightly:
  image: "scorpil/rust:nightly"
  stage: test
  allow_failure: true
  script:
    - rustc --version && cargo --version # Print version info for debugging
    - cargo test --verbose
    - cargo build --features=cli

pages:
  stage: doc
  script:
    - cargo doc
    - mv target/doc public
    - cp .ci/index.html public/index.html
  artifacts:
    paths:
      - public
  only:
    - master

plus i have a manual 'index.html' as redirect to the index of my crate

<html>
  <head>
	<noscript><meta http-equiv="refresh" content="0; url=elf/index.html"></noscript>
  </head>
  <body onload="window.location = 'elf/index.html'">
	<a href="elf/index.html">look here</a>
  </body>
</html>

repository and docs

1 Like