Skip to content

Commit a0aeafb

Browse files
committedFeb 14, 2022
fine tune the doc setup
1 parent ba3e1da commit a0aeafb

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed
 

‎check_all.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ pylint tensorcircuit tests
99
echo "pytest check"
1010
pytest -n 4 --cov=tensorcircuit -vv -W ignore::DeprecationWarning
1111
echo "sphinx check"
12-
cd docs && make html
12+
cd docs && sphinx-build source build/html
1313
echo "all checks passed, congratulates! 💐"

‎docs/source/contribution.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ We use `sphnix <https://www.sphinx-doc.org/en/master/>`__ to manage the document
146146

147147
The source files for docs are .rst file in docs/source.
148148

149-
For English docs, ``make html`` in docs dir is enough. The html version of the docs are in docs/build/html.
149+
For English docs, ``sphinx-build source build/html`` in docs dir is enough. The html version of the docs are in docs/build/html.
150150

151151
**i18n:**
152152

‎docs/source/generate_rst.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
import os, glob, shutil
1+
import os
2+
import glob
3+
import shutil
24
from os.path import join as pj
35

46

‎docs/source/index.rst

+6-8
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,19 @@ Guide to tensorcircuit
22
==================================
33

44
.. toctree::
5-
:maxdepth: 2
65

7-
quickstart.rst
8-
advance.rst
9-
infras.rst
10-
contribution.rst
11-
6+
quickstart.rst
7+
advance.rst
8+
infras.rst
9+
contribution.rst
10+
1211

1312
API References
1413
=======================
1514

1615
.. toctree::
17-
:maxdepth: 4
1816

19-
modules.rst
17+
modules.rst
2018

2119

2220
Indices and tables

0 commit comments

Comments
 (0)
Please sign in to comment.