Skip to content

Add Sphinx documentation #73

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
Open
wants to merge 15 commits into
base: develop
Choose a base branch
from
Open

Add Sphinx documentation #73

wants to merge 15 commits into from

Conversation

rk1a
Copy link

@rk1a rk1a commented Jul 17, 2023 •
edited
Loading

  • Adds dev tools: pre-commit, isort, black, flake8
  • Adds doc strings to minetester python package
  • Adds basic Sphinx documentation of Minetester features
  • Makes dumb client create a recorder by default (without passing --record)
  • Fixes segfault when not passing cursor image
  • Updates README with documentation build instructions

Related issues: #43 #19

Ready for Review.

How to test

pip install -e .[docs]
cd docs-minetester && make livehtml

@rk1a rk1a mentioned this pull request Sep 16, 2023
Open
@rk1a rk1a requested a review from AI-WAIFU December 3, 2023 17:10
@rk1a rk1a mentioned this pull request Jan 17, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AI-WAIFU AI-WAIFU Awaiting requested review from AI-WAIFU

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@rk1a