diff options
| author | bors[bot] <bors[bot]@users.noreply.github.com> | 2019-03-25 06:54:15 +0000 |
|---|---|---|
| committer | bors[bot] <bors[bot]@users.noreply.github.com> | 2019-03-25 06:54:15 +0000 |
| commit | 219b1573377caafaca1dc071f8513ec8be01f199 (patch) | |
| tree | be802fa2d43032312a0b5c3d047b3565c2dc6655 /README.md | |
| parent | 94cf23bfc4738990e6c74424450bc40f0beb2b62 (diff) | |
| parent | 022d88cf4ce786642548d05e16a5a72b4970b110 (diff) | |
Merge #1035
1035: Add master branch docs build and publish r=matklad a=robojumper
Closes #1024.
Additional setup required:
* The rust-analyzer travis repo needs an [environment variable](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings) `DOCS_TOKEN` that will be used to publish docs to the `gh-pages` branch. This is a GitHub access token with the appropriate permissions to push to this repository. Travis will keep this a secret.
* In the GitHub repository settings, the GitHub pages source needs to be set to the `gh-pages` branch. This option will only appear once a branch is created with this exact name -- created either through the `deploy` step or manually.
* In the GitHub repository settings, a GitHub pages theme will need to be chosen. What theme to use is unimportant, but [you must choose a theme](https://github.community/t5/GitHub-Pages/Github-Pages-are-not-published-after-following-the-documentation/m-p/18676#M1398).
Docs are built as part of any rust build (on linux and windows, though all my Travis windows builds have timed out), but only published on master builds on linux.
The docs badge links to `https://rust-analyzer.github.io/rust-analyzer/ra_ide_api/index.html` -- since this project is a cargo workspace, there isn't a global index page, hence just the link to an arbitrarily chosen crate. If this project had a canonical main crate with good documentation, one could link to that. All other crates are accessible through the sidebar.
Co-authored-by: robojumper <[email protected]>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 1 |
1 files changed, 1 insertions, 0 deletions
| @@ -1,6 +1,7 @@ | |||
| 1 | # Rust Analyzer | 1 | # Rust Analyzer |
| 2 | 2 | ||
| 3 | [](https://travis-ci.org/rust-analyzer/rust-analyzer) | 3 | [](https://travis-ci.org/rust-analyzer/rust-analyzer) |
| 4 | [](https://rust-analyzer.github.io/rust-analyzer/ra_ide_api/index.html) | ||
| 4 | 5 | ||
| 5 | Rust Analyzer is an **experimental** modular compiler frontend for the Rust | 6 | Rust Analyzer is an **experimental** modular compiler frontend for the Rust |
| 6 | language. It is a part of a larger rls-2.0 effort to create excellent IDE | 7 | language. It is a part of a larger rls-2.0 effort to create excellent IDE |