[DOCS] add GitHub Actions for deploying Sphinx documentation

[cmgzn]

As the title says.

preview: https://cmgzn.github.io/data-juicer-sandbox/en/main/index.html

[gemini-code-assist]

Summary of Changes

Hello @cmgzn, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly upgrades the project's documentation system by introducing GitHub Actions for automated Sphinx documentation deployment. It includes the addition of detailed user and developer guides, as well as a Q&A section, all available in both English and Chinese. This initiative aims to improve the accessibility and maintainability of the project's documentation, ensuring that all users and contributors have access to comprehensive and up-to-date resources.

Highlights

• Automated Documentation Deployment: GitHub Actions have been implemented to automatically build and deploy the project's Sphinx documentation, streamlining the documentation update process.
• Comprehensive New Documentation: New User Guides, Developer Guides, and Q&A sections have been added, providing extensive information for both English and Chinese-speaking audiences.
• Updated Documentation Links: The main README.md file has been updated to point to the new, centralized Sphinx-generated documentation portal, ensuring users can easily find the latest information.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/deploy_sphinx_docs.yml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces comprehensive documentation for the project, including a User Guide, Developer Guide, and a Q&A section, available in both English and Chinese. It also adds the necessary Sphinx configuration to deploy this documentation via GitHub Actions. The new documentation is well-structured and a valuable addition. I've identified a few minor typos and grammatical errors in the markdown files that could be corrected to enhance clarity. Overall, this is an excellent contribution to the project.