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

Sphinx docs #477

Merged
merged 21 commits into from
Feb 6, 2023
Merged

Sphinx docs #477

merged 21 commits into from
Feb 6, 2023

Conversation

PerchunPak
Copy link
Member

This PR merges sphinx-docs branch, so it wouldn't produce merge conflicts (like #465) as suggested @ItsDrike in Discord.

Note that documentation, in general, is not fully done. Parts (such as FAQ) are still in WIP. I'm also planning to add some "Quick Start" docs, simple examples, etc. but it's in my To-Do now.

There is also a still open conversation by @ItsDrike, which suggests removing mcstatus.dns from public API (see discussion on GitHub and in Discord).

So, this PR does not close the documentation To-Do - #136.

@PerchunPak
Copy link
Member Author

Also, someone, please, resolve those merge conflicts in poetry.lock.

@PerchunPak
Copy link
Member Author

Blocked by #478?

@ItsDrike ItsDrike added area: documentation Related to project's documentation (comments, docstrings, docs) type: feature New request or feature labels Feb 4, 2023
@ItsDrike
Copy link
Member

ItsDrike commented Feb 4, 2023

Since this is merging to master, you can resolve the conflict here, with a merge commit (not with a rebase though, as you might want to rebase from our sphinx-docs if there are some changes, though I don't think there will be any until this gets merged).

@PerchunPak
Copy link
Member Author

Since this is merging to master, you can resolve the conflict here, with a merge commit (not with a rebase though, as you might want to rebase from our sphinx-docs if there are some changes, though I don't think there will be any until this gets merged).

GitHub allows creating PRs even with branches, where you don't have push access. So I created py-mine:sphinx-docs -> py-mine:master.

I also can't change the source branch (sphinx-docs) to mine, without creating a new PR (or just GitHub UI says so).

Copy link
Contributor

@kevinkjt2000 kevinkjt2000 left a comment

Choose a reason for hiding this comment

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

Wayyyyyyy better than what we have currently

Copy link
Member

@ItsDrike ItsDrike left a comment

Choose a reason for hiding this comment

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

LGTM

@kevinkjt2000 kevinkjt2000 merged commit 62682ef into master Feb 6, 2023
@kevinkjt2000 kevinkjt2000 deleted the sphinx-docs branch February 6, 2023 21:10
@PerchunPak PerchunPak mentioned this pull request Feb 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Related to project's documentation (comments, docstrings, docs) type: feature New request or feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants