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

Generate API Documentation on build #334

Closed
vsaw opened this issue Dec 19, 2020 · 4 comments
Closed

Generate API Documentation on build #334

vsaw opened this issue Dec 19, 2020 · 4 comments

Comments

@vsaw
Copy link
Collaborator

vsaw commented Dec 19, 2020

As far as I can tell, the whole API Documentation can be generated with npm run generateapidoc. Therefore it should be considered build artifacts and not be comitted to git.

Ideally, npm run build and npm run dev should build the apidoc automatically when executed.

@vsaw vsaw changed the title Generate API on build Generate API Documentation on build Dec 19, 2020
@vsaw
Copy link
Collaborator Author

vsaw commented Dec 21, 2020

Closed in #336

@vsaw vsaw closed this as completed Dec 21, 2020
@tdurand tdurand reopened this Dec 21, 2020
@tdurand
Copy link
Member

tdurand commented Dec 21, 2020

I'll reopen, as we will need to double check if this works when we merge development into master at some point .. Will probably need to push two commits, the first one will create the gh-pages branch, and then we will need to select the gh-pages branch in the settings as the branch for Github Pages . (currently it is set to master)

Let me know if I missed something

@vsaw
Copy link
Collaborator Author

vsaw commented Dec 21, 2020

You can already prepare the repo to serve from gh-pages. Just create a copy of the master branch and change the settings for the GitHub Pages. This way, once we merge development into master, the action can just run.

You are right that we need to verify that it runs correctly. In my opinion though this feels more like a separate task as this task was to remove the apidoc folder from git (which we did 🎉)

@tdurand
Copy link
Member

tdurand commented Dec 22, 2020

true, will do that and put a note in the development notes

@tdurand tdurand closed this as completed Dec 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants