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

Add action to auto build and deploy doc #14

Merged
merged 1 commit into from
Sep 17, 2024

Conversation

soraxas
Copy link
Contributor

@soraxas soraxas commented Sep 17, 2024

This adds an auto build for the API doc, for the requirement of the JOSS guideline:

Documentation

  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?

The generated doc is deployed at gh-pages branch, and you can host it in github page via setting your repo settings:

image

So that your user can directly refer to your code API

(addresses #4)

@haider8645
Copy link
Collaborator

haider8645 commented Sep 17, 2024

Thanks, I guess that the build fails because it is trying to push to a branch here from your credentials.

@soraxas
Copy link
Contributor Author

soraxas commented Sep 17, 2024

It runs successfully, but it won't be able to deploy to your repo (as this is my PR and doesn't have permission to push to your repo).

@soraxas
Copy link
Contributor Author

soraxas commented Sep 17, 2024

The deployed version should looks like this: https://soraxas.github.io/ugv_nav4d (this is just my fork's gh page)

@haider8645 haider8645 merged commit 82772cc into dfki-ric:main Sep 17, 2024
0 of 2 checks passed
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

Successfully merging this pull request may close these issues.

2 participants