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

Expand Sphinx Dependencies for Documentation Generation #4073

Merged
merged 2 commits into from
Oct 8, 2024

Conversation

Kureii
Copy link
Contributor

@Kureii Kureii commented Oct 7, 2024

While following the instructions to generate the Tiled documentation, I encountered missing dependencies on my system. To resolve this, I have added the following packages to the setup instructions:

  • myst_parser
  • sphinx_design
  • sphinx_reredirects

These additions ensure that all necessary components are available for successful documentation generation, aligning the setup with the current requirements.

Changes:
Updated dependencies list for Sphinx documentation in the setup instructions.
This update should help others avoid missing dependency issues when building the documentation.

@bjorn
Copy link
Member

bjorn commented Oct 7, 2024

Thanks! Actually, I think it would be better to update this documentation to use the docs/requirements.txt file that was added at some point. Could you adjust the patch accordingly?

@Kureii
Copy link
Contributor Author

Kureii commented Oct 7, 2024

okay, I'll do it.

@bjorn bjorn merged commit b56c054 into mapeditor:master Oct 8, 2024
3 checks passed
@bjorn
Copy link
Member

bjorn commented Oct 8, 2024

Thanks! That seems quite verbose, but I guess the note about using virtual environments could be useful (I should probably be using that myself as well, heh).

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