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.

Sign up for GitHub

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

Jump to bottom

Automate docs creation? #11

Closed
davisdude opened this issue Dec 12, 2015 · 2 comments
Closed

Automate docs creation? #11

davisdude opened this issue Dec 12, 2015 · 2 comments
Assignees
@shakesoda
Labels
docs help wanted

Comments

@davisdude
Copy link
Collaborator

Do you think we should include a bat file to automate docs for users?
For instance, what I used looks like this:

@echo off
lua "C:\Program Files (x86)\Lua\ldoc\ldoc.lua" %*
@shakesoda
Copy link
Member

I don't think we should include a bat script, but that they should be generated automatically when pushes happen (maybe we can have travis do it?)

@shakesoda shakesoda added the docs label Dec 17, 2015
@shakesoda shakesoda self-assigned this Dec 21, 2015
@TannerRogalsky
Copy link

Having Travis push to gh-pages is not too bad and is reasonably secure. https://gist.github.com/domenic/ec8b0fc8ab45f39403dd

@idbrii idbrii mentioned this issue Jun 23, 2021
Merged
shakesoda pushed a commit that referenced this issue Jun 23, 2021
@idbrii
Automate ldoc generation
5d303a2 
Related #11.

Builds docs to the gh-pages branch on every push to master. Also updates
all dead links to point to live ones (or ones that will be live after
this is merged).

Uses three third-party gh actions:

* leafo/gh-actions-lua@v8
* leafo/gh-actions-luarocks@v4
* peaceiris/actions-gh-pages@v3
 * This receives secrets.GITHUB_TOKEN

Also switches to the new ldoc css and moves doc output folder to
./doc/out which is less confusing when configuring than ./doc/doc.

Once merged, docs will be available on https://excessive.github.io/cpml/

Currently, you can see the built docs on https://idbrii.github.io/love-cpml/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shakesoda shakesoda

Labels
docs help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@shakesoda @TannerRogalsky @davisdude