File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -49,6 +49,29 @@ make html
4949open 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
Original file line number Diff line number Diff line change 88Dependencies of the CUDA-Python bindings and some versions that are known to
99work 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
6264cd docs_src
6365make html
6466cp -a build/html/. ../docs/
Original file line number Diff line number Diff 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
201201work 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
246248make html
247249cp -a build/html/. ../docs/
248250</ pre > </ div >
Original file line number Diff line number Diff line change 88Dependencies of the CUDA-Python bindings and some versions that are known to
99work 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
6264cd docs_src
6365make html
6466cp -a build/html/. ../docs/
You can’t perform that action at this time.
0 commit comments