Skip to content

Commit 0f64e4a

Browse files
docs: fixed some problems when building docs envs with environment file (#2116)
* fix:fixed environment.yml for building docs env * docs:added alternative buidling method
1 parent 8e8f6cd commit 0f64e4a

File tree

2 files changed

+55
-51
lines changed

2 files changed

+55
-51
lines changed

docs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,17 @@ If python is not from conda envs 'sphinx', you may activate 'sphinx' from the (b
2727

2828
Deactivate `(base)` env, and then `conda activate sphinx`.
2929

30+
If you fail to create conda envs by `environment.yml`, try following commands.
31+
```bash
32+
1. conda create -n sphinx
33+
2. conda activate sphinx
34+
3. pip3 install -U Sphinx
35+
4. pip3 install sphinx-multiversion
36+
5. pip3 install myst-parser
37+
6. pip3 install sphinx-book-theme
38+
7. pip3 install sphinx_copybutton
39+
8. pip3 install myst-parser[linkify]
40+
```
3041
## Tips
3142

3243
Here are some important tips to help you get started:

docs/environment.yml

Lines changed: 44 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,48 @@
11
name: sphinx
2-
channels:
3-
- defaults
42
dependencies:
5-
- alabaster=0.7.12=pyhd3eb1b0_0
6-
- babel=2.9.1=pyhd3eb1b0_0
7-
- brotlipy=0.7.0=py39h9ed2024_1003
8-
- ca-certificates=2022.3.29=hecd8cb5_0
9-
- certifi=2021.10.8=py39hecd8cb5_2
10-
- cffi=1.15.0=py39hc55c11b_1
11-
- charset-normalizer=2.0.4=pyhd3eb1b0_0
12-
- colorama=0.4.4=pyhd3eb1b0_0
13-
- cryptography=36.0.0=py39hf6deb26_0
14-
- docutils=0.17.1=py39hecd8cb5_1
15-
- idna=3.3=pyhd3eb1b0_0
16-
- imagesize=1.3.0=pyhd3eb1b0_0
17-
- importlib-metadata=4.11.3=py39hecd8cb5_0
18-
- jinja2=3.0.3=pyhd3eb1b0_0
19-
- libcxx=12.0.0=h2f01273_0
20-
- libffi=3.3=hb1e8313_2
21-
- markupsafe=2.0.1=py39h9ed2024_0
22-
- ncurses=6.3=hca72f7f_2
23-
- openssl=1.1.1n=hca72f7f_0
24-
- packaging=21.3=pyhd3eb1b0_0
25-
- pip=21.2.4=py39hecd8cb5_0
26-
- pycparser=2.21=pyhd3eb1b0_0
27-
- pygments=2.11.2=pyhd3eb1b0_0
28-
- pyopenssl=22.0.0=pyhd3eb1b0_0
29-
- pyparsing=3.0.4=pyhd3eb1b0_0
30-
- pysocks=1.7.1=py39hecd8cb5_0
31-
- python=3.9.12=hdfd78df_0
32-
- pytz=2021.3=pyhd3eb1b0_0
33-
- readline=8.1.2=hca72f7f_1
34-
- requests=2.27.1=pyhd3eb1b0_0
35-
- setuptools=58.0.4=py39hecd8cb5_0
36-
- snowballstemmer=2.2.0=pyhd3eb1b0_0
37-
- sphinx=4.4.0=pyhd3eb1b0_0
38-
- sphinxcontrib-applehelp=1.0.2=pyhd3eb1b0_0
39-
- sphinxcontrib-devhelp=1.0.2=pyhd3eb1b0_0
40-
- sphinxcontrib-htmlhelp=2.0.0=pyhd3eb1b0_0
41-
- sphinxcontrib-jsmath=1.0.1=pyhd3eb1b0_0
42-
- sphinxcontrib-qthelp=1.0.3=pyhd3eb1b0_0
43-
- sphinxcontrib-serializinghtml=1.1.5=pyhd3eb1b0_0
44-
- sqlite=3.38.2=h707629a_0
45-
- tk=8.6.11=h7bc2e8c_0
46-
- tzdata=2022a=hda174b7_0
47-
- urllib3=1.26.8=pyhd3eb1b0_0
48-
- wheel=0.37.1=pyhd3eb1b0_0
49-
- xz=5.2.5=h1de35cc_0
50-
- zipp=3.7.0=pyhd3eb1b0_0
51-
- zlib=1.2.11=h4dc903c_4
3+
- alabaster=0.7.12
4+
- babel=2.9.1
5+
- brotlipy=0.7.0
6+
- ca-certificates=2022.3.29
7+
- certifi=2021.10.8
8+
- cffi=1.15.0
9+
- charset-normalizer=2.0.4
10+
- colorama=0.4.4
11+
- cryptography=36.0.0
12+
- docutils=0.17.1
13+
- idna=3.3
14+
- imagesize=1.3.0
15+
- importlib-metadata=4.11.3
16+
- jinja2=3.0.3
17+
- markupsafe=2.0.1
18+
- openssl=1.1.1n
19+
- packaging=21.3
20+
- pip=21.2.4
21+
- pycparser=2.21
22+
- pygments=2.11.2
23+
- pyopenssl=22.0.0
24+
- pyparsing=3.0.4
25+
- pysocks=1.7.1
26+
- python=3.9.12
27+
- pytz=2021.3
28+
- requests=2.27.1
29+
- setuptools=58.0.4
30+
- snowballstemmer=2.2.0
31+
- sphinx=4.4.0
32+
- sphinxcontrib-applehelp=1.0.2
33+
- sphinxcontrib-devhelp=1.0.2
34+
- sphinxcontrib-htmlhelp=2.0.0
35+
- sphinxcontrib-jsmath=1.0.1
36+
- sphinxcontrib-qthelp=1.0.3
37+
- sphinxcontrib-serializinghtml=1.1.5
38+
- sqlite=3.38.2
39+
- tk=8.6.11
40+
- tzdata=2022a
41+
- urllib3=1.26.8
42+
- wheel=0.37.1
43+
- xz=5.2.5
44+
- zipp=3.7.0
45+
- zlib=1.2.11
5246
- pip:
5347
- attrs==21.4.0
5448
- beautifulsoup4==4.11.1
@@ -64,5 +58,4 @@ dependencies:
6458
- sphinx-multiversion==0.2.4
6559
- typing-extensions==4.1.1
6660
- uc-micro-py==1.0.1
67-
- sphinx-copybutton=0.5.0
68-
prefix: /Users/mian/miniconda3/envs/sphinx
61+
- sphinx-copybutton==0.5.0

0 commit comments

Comments
 (0)