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

Use Sphinx for documentation instead of mkdocs #80

Merged
merged 1 commit into from
Jul 4, 2024

Conversation

kretep
Copy link
Member

@kretep kretep commented Jul 1, 2024

Migrate documentation from mkdocs to sphinx. Creating a separate PR for this, to make the one with mixed improvements (#79) more manageable.

Biggest advantage of moving to sphinx is that the API reference can be automatically generated (this didn't work with mkdocs).

@kretep kretep requested a review from vedran-kasalica July 1, 2024 09:32
@kretep
Copy link
Member Author

kretep commented Jul 1, 2024

The "build" action is failing as expected; it is replaced by "build-and-test" in #79 .

@vedran-kasalica
Copy link
Member

The "build" action is failing as expected; it is replaced by "build-and-test" in #79 .

To fix the issue, should we then update or remove .github/workflows/python-package.yml?

Copy link
Member

@vedran-kasalica vedran-kasalica left a comment

Choose a reason for hiding this comment

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

I agree with the idea of switching to Sphinx, and the changes in the PR reflect that well.

@kretep
Copy link
Member Author

kretep commented Jul 4, 2024

To fix the issue, should we then update or remove .github/workflows/python-package.yml?

We can remove it

@vedran-kasalica
Copy link
Member

To fix the issue, should we then update or remove .github/workflows/python-package.yml?

We can remove it

Do you prefer doing it before or after we merge this PR?

@kretep
Copy link
Member Author

kretep commented Jul 4, 2024

Its removal is also part of #79, so I was thinking to just not do it twice, although there won't be any conflicts if we remove it here

@vedran-kasalica vedran-kasalica merged commit 0726a8d into main Jul 4, 2024
2 of 3 checks passed
@vedran-kasalica vedran-kasalica deleted the migrate-documentation branch July 4, 2024 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants