Commit Graph

3 Commits

Author SHA1 Message Date
François
026563cb1e Deploy dev docs - install dependencies (#4222)
# Objective

- #3535 introduced deploying docs without installing dependencies
- https://github.com/bevyengine/bevy/runs/5562769081?check_suite_focus=true

## Solution

- copied 6ff17eaab8/.github/workflows/ci.yml (L270-L271)
2022-03-16 02:08:25 +00:00
François
6ff17eaab8 Deploy dev docs - fix sed command (#4221)
# Objective

- #3535 introduced deploying docs with an error in sed command

## Solution

- fix sed command
- make the command cross platform
2022-03-15 23:52:44 +00:00
James Liu
e020c57211 Add automatic docs deployment to GitHub Pages (#3535)
# Objective

Partially address #407 by setting up automated deployments of `bevy`'s API reference to GitHub Pages.

## Solution

Set up a GitHub Actions workflow that builds the docs on every push to `main` and pushes a new commit to a `gh-pages` (or `docs` branch).

A few smaller additions to better address #407:

 - A top level redirect was added to take "docs.bevyengine.org" directly to the `bevy` crate docs.
 - A GitHub Pages CNAME file for supporting a publicly viewable domain instead of `github.io`
 - A robots.txt file is added to disable all search engine crawlers that respect it from crawling it (avoid having conflicting Google search results)
 - A .nojekyl file to speed up deployments since there is no Jekyll templating in the output.

This may require configuration of the  `GITHUB_TOKEN` of the CI to successfully run this.

## Followup

For this to completely resolve #407, a subdomain of https://bevyengine.org/ needs to be set up to point to the CNAME location. This is initially set to "dev-docs.bevyengine.org".

Co-authored-by: Carter Anderson <mcanders1@gmail.com>
2022-03-15 23:00:49 +00:00