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

Documentation: Full Paths #26

Open
JackAtGaia opened this issue Mar 1, 2022 · 4 comments
Open

Documentation: Full Paths #26

JackAtGaia opened this issue Mar 1, 2022 · 4 comments

Comments

@JackAtGaia
Copy link

Greetings, like the action. Worked pretty flawlessly once I figured it out.

I am not sure if I am unique, but I like to specify things by full paths to be sure I have things specified correctly.

so, in my workflow, I created a directory to hold the output, and then did some search & replace on the doxyfile to match.

mkdir -p ${{ github.workspace }}/doxygen-output
          sed -i 's|@CMAKE_CURRENT_BINARY_DIR@|${{ github.workspace }}/doxygen-output|g' ${{ github.workspace }}/production/docs/doxyfile
          sed -i 's|@CMAKE_CURRENT_SOURCE_DIR@/../|${{ github.workspace }}/production|g' ${{ github.workspace }}/production/docs/doxyfile

After getting some errors, it took me a bit to figure out that I needed to replace ${{ github.workspace }} with /github/workspace as it was being mounted inside a docker container.

That might be something you want to point out for people using full paths.

@ruffner
Copy link

ruffner commented Apr 19, 2022

I have a question about paths as well, I cannot seem to get the action to succeed, it either cant find the output folder or the Doxyfile that I have.

From you comment above I am wondering if I need to edit my Doxyfile to use this action of if it is a matter of my yaml config.

I am trying to build docs with this action then deploy to github pages. Here is my full yaml

name: Doxygen GitHub Pages Deploy Action

on:
  push:
    branches:
      - develop
  workflow_dispatch:

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: mattnotmitt/[email protected]
      - uses: DenverCoder1/doxygen-github-pages-action@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          branch: gh-pages
          folder: doc

In my repository (https://github.com/movetones/Gravitone_ArduinoLibrary) I have a Doxyfile in thr root directory and I want to put the output of Doxygen in to the doc/ folder.

Any responses are appreciated.

@mattnotmitt
Copy link
Owner

@JackAtGaia thanks for bringing this to my attention! I'll update the docs to try and help & sorry for taking so long to reply.

@ruffner you need to set your OUTPUT_DIRECTORY setting in your Doxyfile to doc.

@ruffner
Copy link

ruffner commented Apr 20, 2022

@mattnotmitt thanks for your reply, but I tried that and the problem seems to be with your script not finding my Doxyfile to begin with when github actions runs it in a docker container:
image
I've tried various working directiories including the default with no joy.

@mattnotmitt
Copy link
Owner

@ruffner looks like you've figured it out, but you were missing the checkout action while you were using my action.

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

No branches or pull requests

3 participants