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（美国化学会）论文网络爬虫，具有现代化仪表板和分析功能。

----

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

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

   .. grid-item::

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

         :octicon:`mark-github` GitHub

   .. grid-item::

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

         :octicon:`issue-opened` Issues

   .. grid-item::

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

         :octicon:`comment-discussion` Discuss

----

Getting Started / 快速开始
--------------------------

.. grid:: 2
   :gutter: 3

   .. grid-item-card:: :octicon:`rocket` Quick Start / 快速开始
      :link: en/quickstart
      :link-type: doc
      :class-title: sd-text-center

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

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

   .. grid-item-card:: :octicon:`browser` Web Interface / Web 界面
      :link: en/web_usage
      :link-type: doc
      :class-title: sd-text-center

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

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

   .. grid-item-card:: :octicon:`download` Installation / 安装
      :link: en/installation
      :link-type: doc
      :class-title: sd-text-center

      Detailed setup instructions for different environments.

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

   .. grid-item-card:: :octicon:`plug` API Usage / API 使用
      :link: en/api_usage
      :link-type: doc
      :class-title: sd-text-center

      Programmatic access with REST API and Python examples.

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

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

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

   .. grid-item-card:: :octicon:`book` 43 Built-in Journals
      :class-title: sd-text-center

      Pre-configured ACS journal list

      43 个内置期刊

   .. grid-item-card:: :octicon:`zap` Real-time Crawling
      :class-title: sd-text-center

      Extract papers instantly

      实时爬取

   .. grid-item-card:: :octicon:`search` Complete Metadata
      :class-title: sd-text-center

      Title, DOI, authors, more

      完整元数据

   .. grid-item-card:: :octicon:`graph` Modern Dashboard
      :class-title: sd-text-center

      Interactive charts

      现代化仪表板

   .. grid-item-card:: :octicon:`filter` Advanced Filtering
      :class-title: sd-text-center

      Search by multiple fields

      高级过滤

   .. grid-item-card:: :octicon:`sync` Background Jobs
      :class-title: sd-text-center

      Async with progress

      后台任务

----

.. admonition:: :octicon:`law` 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