ayo/ipex-llm
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

[Doc] Update doc requirements link (#6780)

Browse source 
* Update doc requirements link in readthedocs yml file

* Update related doc README

* Small doc fix
This commit is contained in:
Yuwen Hu 2022-11-28 15:13:44 +08:00 committed by GitHub
parent 3571247d65
commit c87c01bd8d
3 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.readthedocs.yml
View file

@ -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

4
docs/readthedocs/README.md
View file

@ -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

4
docs/readthedocs/source/index.rst
View file

@ -1,5 +1,5 @@
BigDL: fast, distributed, secure AI for Big Data
===========================
=================================================
`BigDL <https://github.com/intel-analytics/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::