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

docs: use github pages instead of readthedocs #259

Open
smartcmd opened this issue Jun 14, 2024 · 1 comment
Open

docs: use github pages instead of readthedocs #259

smartcmd opened this issue Jun 14, 2024 · 1 comment
Labels
Documentation Improvements or additions to documentation

Comments

@smartcmd
Copy link
Member

No description provided.

@smartcmd smartcmd added the Documentation Improvements or additions to documentation label Jun 14, 2024
@smartcmd smartcmd changed the title docs: use gh pages instead of readthedocs docs: use github pages instead of readthedocs Jun 14, 2024
@Cdm2883 Cdm2883 self-assigned this Sep 28, 2024
@Cdm2883 Cdm2883 removed their assignment Oct 30, 2024
@Cdm2883
Copy link
Contributor

Cdm2883 commented Jan 4, 2025

.github/workflows/gh-pages.yml

name: Publish docs via GitHub Pages

on:
  push:
    branches: [ "master" ]
    paths:
      - docs/**
      - mkdocs.yml

jobs:
  build:
    name: Deploy Docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v1

      - name: Deploy Docs
        uses: mhausenblas/mkdocs-deploy-gh-pages@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          REQUIREMENTS: docs/requirements.txt

Try this 🥺 @smartcmd
You need to switch Settings -> Actions -> General -> Workflow permissions to Read and write permissions first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants