From c87c01bd8deec88715c70aff9c15281ecc7e43f9 Mon Sep 17 00:00:00 2001 From: Yuwen Hu <54161268+Oscilloscope98@users.noreply.github.com> Date: Mon, 28 Nov 2022 15:13:44 +0800 Subject: [PATCH] [Doc] Update doc requirements link (#6780) * Update doc requirements link in readthedocs yml file * Update related doc README * Small doc fix --- .readthedocs.yml | 2 +- docs/readthedocs/README.md | 4 ++-- docs/readthedocs/source/index.rst | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 56854173..6111552e 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -13,7 +13,7 @@ build: - graphviz jobs: pre_install: - - wget https://raw.githubusercontent.com/analytics-zoo/BigDL/main/python/test/python-requirements/requirements-doc.txt + - wget https://raw.githubusercontent.com/analytics-zoo/gha-cicd-env/main/python-requrirements/requirements-doc.txt sphinx: configuration: docs/readthedocs/source/conf.py diff --git a/docs/readthedocs/README.md b/docs/readthedocs/README.md index a687780c..d92d938e 100644 --- a/docs/readthedocs/README.md +++ b/docs/readthedocs/README.md @@ -18,10 +18,10 @@ pip install --upgrade pip "setuptools<58.3.0" pip install --upgrade pillow mock==1.0.1 "alabaster>=0.7,<0.8,!=0.7.5" commonmark==0.9.1 recommonmark==0.5.0 sphinx sphinx-rtd-theme "readthedocs-sphinx-ext<2.3" # for other documentation related dependencies -wget https://raw.githubusercontent.com/analytics-zoo/BigDL/main/python/test/python-requirements/requirements-doc.txt +wget https://raw.githubusercontent.com/analytics-zoo/gha-cicd-env/main/python-requrirements/requirements-doc.txt pip install -r requirements-doc.txt ``` -> **Note**: When adding new sphinx extensions for our documentation, the requirements file located [here](https://github.com/analytics-zoo/BigDL/blob/main/python/test/python-requirements/requirements-doc.txt) should be modified. +> **Note**: When adding new sphinx extensions for our documentation, the requirements file located [here](https://raw.githubusercontent.com/analytics-zoo/gha-cicd-env/main/python-requrirements/requirements-doc.txt) should be modified. ### 2. Build the documentation You can then build the documentation locally through: ```bash diff --git a/docs/readthedocs/source/index.rst b/docs/readthedocs/source/index.rst index 322ab705..7193d1db 100644 --- a/docs/readthedocs/source/index.rst +++ b/docs/readthedocs/source/index.rst @@ -1,5 +1,5 @@ BigDL: fast, distributed, secure AI for Big Data -=========================== +================================================= `BigDL `_ seamlessly scales your data analytics & AI applications from laptop to cloud, with the following libraries: @@ -13,7 +13,7 @@ BigDL: fast, distributed, secure AI for Big Data ------ Choosing the right BigDL library ---------------------------- +--------------------------------- .. graphviz::