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

building the docs based on the modules in requirements.txt #438

Merged
merged 1 commit into from
Oct 19, 2024

Conversation

OmarAI2003
Copy link
Contributor

Contributor checklist


Description

  • Ensured compatibility with req.txt modules.
  • Adjusted the documentation build process to successfully generate the HTML output without significant warnings or errors.
    a

Testing:

  • The build was tested using the git bash command python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html, resulting in a successful build with no warnings.

Related issue

Copy link

github-actions bot commented Oct 19, 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)

@OmarAI2003
Copy link
Contributor Author

@andrewtavis I hope this works for you now!

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.

Let's give it a shot, @OmarAI2003! 🚀

@andrewtavis andrewtavis merged commit 698fe09 into scribe-org:main Oct 19, 2024
6 checks passed
@OmarAI2003
Copy link
Contributor Author

Please update me if anything happened!

@OmarAI2003 OmarAI2003 deleted the Fix_docs_build branch October 19, 2024 14:45
@andrewtavis andrewtavis added the hacktoberfest-accepted Accepted as a part of Hacktoberfest label Oct 20, 2024
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.

2 participants