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

Host documentation #5

Closed
kvark opened this issue Jul 12, 2017 · 8 comments · Fixed by #276 · May be fixed by #241
Closed

Host documentation #5

kvark opened this issue Jul 12, 2017 · 8 comments · Fixed by #276 · May be fixed by #241

Comments

@kvark
Copy link
Member

kvark commented Jul 12, 2017

Most of the project rely on docs.rs for documentation, however it only builds Linux at the moment. We need to find a good way of providing the documentation here.

cc @fkaa @JohnColanduoni

@kvark
Copy link
Member Author

kvark commented Jul 12, 2017

Related - https://github.com/onur/docs.rs/pull/73

@mjadczak
Copy link
Contributor

mjadczak commented Mar 1, 2018

Also related to this: https://github.com/onur/docs.rs/issues/93

@IsaccBarker
Copy link
Contributor

IsaccBarker commented Dec 10, 2022

I know this is a really old issue, but I found a way to do it with GitHub's new Actions to Pages functionality. Below is an example, and you can find working documentation hosted on my fork, that was built with GitHub actions.

name: Rust

on:
  push:
    branches: [ "master" ]
  pull_request:
    branches: [ "master" ]
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: true

env:
  CARGO_TERM_COLOR: always

jobs:
  build:
    runs-on: macos-latest
    steps:
    - uses: actions/checkout@v3
    - name: Document
      run: cargo doc --verbose
    - name: Packaging
      run: mv target/doc _site
    - name: Upload artifact
      uses: actions/upload-pages-artifact@v1
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1

You (@kvark) have to set it up in the repository settings though.

@notgull
Copy link

notgull commented Dec 10, 2022

Most of the project rely on docs.rs for documentation, however it only builds Linux at the moment.

Since this is no longer true, should this issue be closed?

@IsaccBarker
Copy link
Contributor

If this still true? The about builds page for docs.rs says:

All targets other than x86_64-unknown-linux-gnu are cross-compiled. For implementation reasons, this is unlikely to change for the foreseeable future.

Correct me if I'm wrong, but wouldn't out-of-ecosystem platform specific libraries still be needed, that couldn't be brought in?

@kvark
Copy link
Member Author

kvark commented Mar 4, 2023

@IsaccBarker would you mind making a PR?
What do I need to set up?

@madsmtm
Copy link
Contributor

madsmtm commented Mar 4, 2023

I'm able to generate documentation for icrate::Metal, I think the problem is mostly just that you've enabled objc's objc_exception feature, which requires compiling with cc.

@cwfitzgerald
Copy link
Member

I think this can be closed now that #303 landed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants