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

Fix/sphinx docs build issue #418

Merged
merged 5 commits into from
Oct 19, 2024

Conversation

OmarAI2003
Copy link
Contributor

@OmarAI2003 OmarAI2003 commented Oct 18, 2024

Contributor checklist


Description

  • Commented out the deprecated call to get_html_theme_path() in the conf.py file to resolve Sphinx build issues.
  • Fixed the import error in process_wiki.py by removing the outdated reference to get_language_words_to_remove and get_language_words_to_ignore.

Details:

  • Ensured compatibility with Sphinx v7.4.7 by removing deprecated and incompatible code.
  • Adjusted the documentation build process to successfully generate the HTML output without significant warnings or errors.
  • Fixed issues related to autosummary generation and resolved warnings related to module imports.

Testing:

  • The build was tested using the powershell command sphinx-build -b html docs/source/ build/, resulting in a successful build with no warnings.

Let me Know your thoughts
@Khushalsarode, @AnishereMariam

Related issue

- Removed the import and usage of get_language_words_to_ignore from process_wiki.py.
- Updated the gen_autosuggestions function to use an empty list for ignore words.
- Eliminated the import statement for get_language_words_to_remove.
- Updated process_wiki.py to remove the dependency on this function.
Copy link

github-actions bot commented Oct 18, 2024

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Data rooms once you're in. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you!

Maintainer checklist

  • The linting and formatting workflow within the PR checks do not indicate new errors in the files changed

  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

@andrewtavis andrewtavis added the hacktoberfest-accepted Accepted as a part of Hacktoberfest label Oct 18, 2024
@mhmohona mhmohona requested a review from andrewtavis October 18, 2024 12:46
Copy link
Member

@mhmohona mhmohona left a comment

Choose a reason for hiding this comment

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

I am able to build the doc successfully now. Great work @OmarAI2003! ✨

@OmarAI2003
Copy link
Contributor Author

I am able to build the doc successfully now. Great work @OmarAI2003! ✨

This is a great thing to hear. You're welcome.

@OmarAI2003
Copy link
Contributor Author

With this last commit, the docs now build for phinx-autobuild as well. However, with phinx-autobuild, we need to download some additional modules. @andrewtavis Do you want me to update this in requirements.txt, or is phinx-build sufficient?

@andrewtavis
Copy link
Member

Let's see if the current one deploys to Read the Docs. If yes, then no stress 😊 If no, then we can revisit it.

Copy link
Member

@andrewtavis andrewtavis left a comment

Choose a reason for hiding this comment

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

Thanks for this, @OmarAI2003! Let's see how this works :)

@andrewtavis andrewtavis merged commit 5f1d77f into scribe-org:main Oct 19, 2024
5 checks passed
@OmarAI2003 OmarAI2003 deleted the fix/sphinx-docs-build-issue branch October 19, 2024 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Accepted as a part of Hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants