ACS Paper Crawler Documentation
=================================

.. image:: https://img.shields.io/badge/python-3.9%2B-blue.svg
   :target: https://www.python.org/downloads/
   :alt: Python Version

.. image:: https://img.shields.io/badge/FastAPI-0.115%2B-009688.svg
   :target: https://fastapi.tiangolo.com/
   :alt: FastAPI

.. image:: https://readthedocs.org/projects/acs-crawler/badge/?version=latest
   :target: https://acs-crawler.readthedocs.io/
   :alt: Documentation Status

.. image:: https://img.shields.io/badge/license-Educational-green.svg
   :alt: License

A professional web-based crawler for American Chemical Society (ACS) papers with modern dashboard and analytics.

专业的 ACS（美国化学会）论文网络爬虫，具有现代化仪表板和分析功能。

----

.. grid:: 2
   :gutter: 3

   .. grid-item-card:: 🚀 Quick Start / 快速开始
      :link: en/quickstart
      :link-type: doc

      Get started in minutes with installation and your first crawl job.

      几分钟内完成安装并开始第一个爬取任务。

   .. grid-item-card:: 🖥️ Web Interface / Web 界面
      :link: en/web_usage
      :link-type: doc

      Learn how to use the dashboard, browse papers, and manage jobs.

      学习如何使用仪表板、浏览论文和管理任务。

   .. grid-item-card:: 🛠️ Installation / 安装
      :link: en/installation
      :link-type: doc

      Detailed setup instructions for different environments.

      不同环境下的详细安装说明。

   .. grid-item-card:: 🔌 API Usage / API 使用
      :link: en/api_usage
      :link-type: doc

      Programmatic access with REST API and Python examples.

      REST API 和 Python 示例的编程访问。

Features / 功能特性
-------------------

.. grid:: 1 2 2 3
   :gutter: 2

   .. grid-item-card:: 📚 43 Built-in Journals / 43 个内置期刊

      Pre-configured ACS journal list ready to use

      预配置的 ACS 期刊列表

   .. grid-item-card:: ⚡ Real-time Crawling / 实时爬取

      Extract papers from ACS Publications instantly

      即时从 ACS Publications 提取论文

   .. grid-item-card:: 🔍 Complete Metadata / 完整元数据

      Title, DOI, authors, abstract, keywords, citations

      标题、DOI、作者、摘要、关键词、引用

   .. grid-item-card:: 📊 Modern Dashboard / 现代化仪表板

      Interactive charts and statistics

      交互式图表和统计

   .. grid-item-card:: 🎯 Advanced Filtering / 高级过滤

      Search by title, author, journal, year

      按标题、作者、期刊、年份搜索

   .. grid-item-card:: 🔄 Background Jobs / 后台任务

      Async crawling with progress tracking

      异步爬取，进度追踪

Quick Links / 快速链接
----------------------

.. button-link:: https://github.com/gxf1212/ACS_crawler
   :color: primary
   :outline:

   :octicon:`mark-github` View on GitHub / 查看 GitHub

.. button-link:: https://github.com/gxf1212/ACS_crawler/issues
   :color: secondary
   :outline:

   :octicon:`issue-opened` Report Issues / 报告问题

.. button-link:: https://github.com/gxf1212/ACS_crawler/discussions
   :color: secondary
   :outline:

   :octicon:`comment-discussion` Discussions / 讨论

----

.. admonition:: License & Usage / 许可证与使用
   :class: tip

   This software is for **educational and research purposes only**. Users are responsible for complying with ACS Terms of Service.

   本软件仅用于 **教育和研究目的** 。用户需自行遵守 ACS 服务条款。

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Getting Started

   en/installation
   en/quickstart

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Usage

   en/web_usage
   en/api_usage

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Development

   en/api
   en/architecture
   en/contributing
   en/license

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: 快速开始

   zh/installation
   zh/quickstart

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: 使用指南

   zh/web_usage
   zh/api_usage
   zh/troubleshooting

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: 开发

   zh/api
   zh/architecture
   zh/contributing
   zh/license