Automate ldoc generation #61
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Related excessive#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/
|
thanks! this is really helpful |
|
@shakesoda Do you want to add http://excessive.github.io/cpml/ as the website in About to make the link more prominent? |
done |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#11 mentioned using github actions to generate docs. I did that on some of my repos recently so I thought I'd contribute the same change here. This also introduces the install_and_build_docs script which will install ldoc and build the docs.
Quick version: After every push to master, it will generate docs to gh-pages so they look like this.
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:
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/