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

Jump to bottom

Add Mkdocs API site #8133

Merged
merged 4 commits into from Apr 12, 2019
Merged

Add Mkdocs API site #8133

merged 4 commits into from Apr 12, 2019

Conversation

p-ouellette
Copy link
Contributor

A friendlier display of lua_api.txt. See #7084.

I used GitLab Pages because it doesn't require using a gh-pages branch or giving Travis access to the repo.

Tested here: https://pauloue.gitlab.io/minetest/.

ClobberXD
ClobberXD reviewed Jan 25, 2019
View reviewed changes
mkdocs/build.sh Outdated Show resolved Hide resolved
@ClobberXD
Copy link
Contributor

The folder trees look a little weird. See the mod directory structure section for an example: https://pauloue.gitlab.io/minetest/mods/#mod-directory-structure

@p-ouellette
Copy link
Contributor Author

I already fixed that (see the force-push), it just didn't update due to a build failure.

@SmallJoker
Copy link
Member

The implementation looks good (demo site). Could you please use tabs for the shell script, like all other util scripts?
I'm not sure about the other files, but tabs should be used where's possible.

@rubenwardy rubenwardy added this to the 5.1.0 milestone Jan 26, 2019
@paramat
Copy link
Contributor

paramat commented Feb 17, 2019

This is a very good idea.

nerzhul
nerzhul previously requested changes Feb 18, 2019
View reviewed changes
Copy link
Member

@nerzhul nerzhul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea of autogenerated doc through pages. We can bind a minetest.net domain on it if needed.
thanks for your contribution it's nice.

.gitlab-ci.yml Outdated Show resolved Hide resolved
@p-ouellette
Copy link
Contributor Author

The CI stopped working for some reason: https://gitlab.com/pauloue/minetest/-/jobs/163549298 (not because of python3.7). It worked 3 weeks ago: https://gitlab.com/pauloue/minetest/-/jobs/151355185.

@p-ouellette
Copy link
Contributor Author

p-ouellette commented Feb 19, 2019 •
edited

Fixed. There was something wrong with the latest version of pip.

@paramat paramat dismissed nerzhul’s stale review April 3, 2019 00:37

"python3.7 please" done

@paramat paramat added the Feature ✨ PRs that add or enhance a feature label Apr 3, 2019
@rubenwardy rubenwardy requested a review from nerzhul April 11, 2019 19:04
rubenwardy
rubenwardy approved these changes Apr 11, 2019
View reviewed changes
Copy link
Member

@rubenwardy rubenwardy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Subject to nerzhul confirming that the gitlab side of this is good

@nerzhul nerzhul merged commit bb7afd3 into minetest:master Apr 12, 2019
@nerzhul
Copy link
Member

nerzhul commented Apr 12, 2019

See http://minetest.gitlab.io/minetest/ (Gitlab autogenerated URL)

@p-ouellette p-ouellette deleted the apisite branch April 12, 2019 23:48
@paramat paramat mentioned this pull request Apr 21, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ClobberXD ClobberXD ClobberXD left review comments

@nerzhul nerzhul nerzhul approved these changes

@rubenwardy rubenwardy rubenwardy approved these changes

Assignees
No one assigned
Labels
@ Documentation Feature ✨ PRs that add or enhance a feature
Projects
None yet
Milestone
5.1.0
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@p-ouellette @ClobberXD @SmallJoker @paramat @nerzhul @rubenwardy