Skip to content

Commit 88dcefc

Browse files
committed
install updates
1 parent 35768f5 commit 88dcefc

5 files changed

Lines changed: 34 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,29 @@ make html
4949
open build/html/index.html
5050
```
5151

52+
### Build the Docs
53+
54+
```
55+
conda env create -f docs_src/environment-docs.yml
56+
conda activate cuda-python-docs
57+
```
58+
Then compile and install `cuda-python` following the steps above.
59+
60+
```
61+
cd docs_src
62+
make html
63+
open build/html/index.html
64+
```
65+
66+
### Publish the Docs
67+
68+
```
69+
git checkout gh-pages
70+
cd docs_src
71+
make html
72+
cp -a build/html/. ../docs/
73+
```
74+
5275
## Testing
5376

5477
### Requirements

‎docs/_sources/install.md.txt‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,9 @@
88
Dependencies of the CUDA-Python bindings and some versions that are known to
99
work are as follows:
1010

11-
* CUDA Toolkit 11.x
11+
* CUDA Toolkit 11.0 to 11.4 - e.g. 11.4.48
1212
* Cython - e.g. 0.29.21
13+
* Versioneer - e.g. 0.20
1314

1415
## Compilation
1516

@@ -59,6 +60,7 @@ open build/html/index.html
5960
### Publish the Docs
6061

6162
```{code-block} shell
63+
git checkout gh-pages
6264
cd docs_src
6365
make html
6466
cp -a build/html/. ../docs/

‎docs/install.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,9 @@ <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to t
200200
<p>Dependencies of the CUDA-Python bindings and some versions that are known to
201201
work are as follows:</p>
202202
<ul class="simple">
203-
<li><p>CUDA Toolkit 11.x</p></li>
203+
<li><p>CUDA Toolkit 11.0 to 11.4 - e.g. 11.4.48</p></li>
204204
<li><p>Cython - e.g. 0.29.21</p></li>
205+
<li><p>Versioneer - e.g. 0.20</p></li>
205206
</ul>
206207
</div>
207208
<div class="section" id="compilation">
@@ -242,7 +243,8 @@ <h2>Build the Docs<a class="headerlink" href="#build-the-docs" title="Permalink
242243
</div>
243244
<div class="section" id="publish-the-docs">
244245
<h3>Publish the Docs<a class="headerlink" href="#publish-the-docs" title="Permalink to this headline"></a></h3>
245-
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> docs_src
246+
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>git checkout gh-pages
247+
<span class="nb">cd</span> docs_src
246248
make html
247249
cp -a build/html/. ../docs/
248250
</pre></div>

‎docs/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs_src/source/install.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,9 @@
88
Dependencies of the CUDA-Python bindings and some versions that are known to
99
work are as follows:
1010

11-
* CUDA Toolkit 11.x
11+
* CUDA Toolkit 11.0 to 11.4 - e.g. 11.4.48
1212
* Cython - e.g. 0.29.21
13+
* Versioneer - e.g. 0.20
1314

1415
## Compilation
1516

@@ -59,6 +60,7 @@ open build/html/index.html
5960
### Publish the Docs
6061

6162
```{code-block} shell
63+
git checkout gh-pages
6264
cd docs_src
6365
make html
6466
cp -a build/html/. ../docs/

0 commit comments

Comments
 (0)