search

ammaraskar / sphinx-action

Github action that builds docs using sphinx and places errors inline
Apache License 2.0
189 stars 114 forks source link

Need explanation #29

Open kridsadakorn opened 3 years ago

kridsadakorn commented 3 years ago

Dear Authors,

I am quite naive about Github Action. What I want to do is to create the HTML documents from a public repository. Let say, I want to create the HTML documents from NumPy. How could I do that? Here is my naive script, it doesn't work. It would be great if you help me to point it out.

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@master
      with:
        repository: numpy/numpy
        path: .
    - uses: ammaraskar/sphinx-action@master
      with:
        build-command: "sphinx-build -b html . _build"
        docs-folder: "doc/"

Thank you.