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

Update rockspec post migration, modernize and lint #332

Merged
merged 3 commits into from
Apr 29, 2023

Conversation

alerque
Copy link
Member

@alerque alerque commented Oct 2, 2020

Similar to lunarmodules/Penlight#357 but in this case motivated by obsolete URLs.

@Tieske Do we have a plan to get the documentation URL migrated as well? I changed it in the rockspec here but it isn't actually live yet.

@alerque alerque changed the title Rockspec version Update rockspec post migration, modernize and lint Oct 2, 2020
@Tieske
Copy link
Member

Tieske commented Oct 3, 2020

Do we have a plan to get the documentation URL migrated as well? I changed it in the rockspec here but it isn't actually live yet.

the doc folder in the repo should be renamed to docs, then I can enable the docs site and update the url in the repo settings. Should anything elese be updated if we rename that dir? Maybe add a makefile target for generating the docs?

@alerque
Copy link
Member Author

alerque commented Oct 3, 2020

Sure, I'll check it out.

AntumDeluge pushed a commit to AntumDeluge/LDoc that referenced this pull request Aug 1, 2021
Related lunarmodules#332.

Add doc-site target to make file and yml file to build the docs.
Following domenic's guide [1] but using leafo's gh actions like
luacheck.yml.

Builds the documentation for ldoc using the checked out version of ldoc
and uses peaceiris/actions-gh-pages to publish.

Once merged, docs will be available on https://lunarmodules.github.io/LDoc

[1]: https://gist.github.com/domenic/ec8b0fc8ab45f39403dd
AntumDeluge pushed a commit to AntumDeluge/LDoc that referenced this pull request Aug 2, 2021
Related lunarmodules#332.

Add doc-site target to make file and yml file to build the docs.
Following domenic's guide [1] but using leafo's gh actions like
luacheck.yml.

Builds the documentation for ldoc using the checked out version of ldoc
and uses peaceiris/actions-gh-pages to publish.

Once merged, docs will be available on https://lunarmodules.github.io/LDoc

[1]: https://gist.github.com/domenic/ec8b0fc8ab45f39403dd
@alerque
Copy link
Member Author

alerque commented Apr 29, 2023

I think the docs should probably moved to a branch not a different directory. In any case I plan to deal with that in another PR.

@alerque alerque merged commit 0b4f19e into lunarmodules:master Apr 29, 2023
@alerque alerque deleted the rockspec-version branch April 29, 2023 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants